aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-04-07 11:50:25 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-04-07 11:50:25 +0000
commit838f5451c4f2617dbb4ac87288ebcde03ea73284 (patch)
treee31e6a09f7f64b471df3f1481ae6950ea1599747
parent5fadf331969198bfd7004bab9df672641e7b85ed (diff)
downloadpaludis-838f5451c4f2617dbb4ac87288ebcde03ea73284.tar.gz
paludis-838f5451c4f2617dbb4ac87288ebcde03ea73284.tar.xz
HOWTO.txt -> HOWTO.rst, thanks to g2boojum
-rw-r--r--README2
-rw-r--r--doc/HOWTO.rst (renamed from doc/HOWTO.txt)52
-rw-r--r--doc/Makefile.am2
3 files changed, 33 insertions, 23 deletions
diff --git a/README b/README
index f3a99bc..70df57f 100644
--- a/README
+++ b/README
@@ -11,6 +11,6 @@ installed, and having GraphViz will help too). It will be created under
stuck in a disused lavatory with a sign on the door saying 'Beware of the
Leopard'.
-There's also a mini howto type thing in 'doc/HOWTO.txt'.
+There's also a mini howto type thing in 'doc/HOWTO.rst'.
.. vim: set spell spelllang=en tw=80 : ..
diff --git a/doc/HOWTO.txt b/doc/HOWTO.rst
index a3caf1b..74c411c 100644
--- a/doc/HOWTO.txt
+++ b/doc/HOWTO.rst
@@ -1,7 +1,12 @@
- HOWTO Break your system using Paludis
- and maybe get a usable chroot if you're lucky
+=====================================
+HOWTO Break your system using Paludis
+=====================================
+---------------------------------------------
+and maybe get a usable chroot if you're lucky
+---------------------------------------------
- *** READ EVERYTHING CAREFULLY, OR YOU WILL BREAK YOUR SYSTEM! ***
+.. DANGER::
+ READ EVERYTHING CAREFULLY, OR YOU WILL BREAK YOUR SYSTEM!
THIS WILL PROBABLY NOT ACTUALLY WORK! Paludis is at the very early alpha stage.
It can sometimes install things, if you're very lucky, but it can't uninstall
@@ -13,7 +18,7 @@ Do not try to use Paludis and Portage to install things inside the same root.
The config and vdb formats are not compatible!
Install Paludis locally, being sure to configure sysconfdir as /etc to avoid
-confusion later on. There's an ebuild at:
+confusion later on. There's an ebuild at::
http://svn.berlios.de/viewcvs/*checkout*/paludis/overlay/sys-apps/paludis/paludis-0.ebuild
@@ -23,9 +28,11 @@ grabbing an svn snapshot of eselect if 1.0.2 hasn't been released yet.
Make sure the test suite passes (either FEATURES="test" for Portage, or 'make
check'). If it fails, don't continue until you figure out why.
-Set up a local bootstrap config directory. We're assuming you're using /mychroot
-as the root path. The reason for doing things this way will become apparent
-later on.
+Set up a local bootstrap config directory. We're assuming you're using
+/mychroot as the root path. The reason for doing things this way will become
+apparent later on.
+
+::
mkdir ~/.paludis-bootstrap
cat <<END > ~/.paludis-bootstrap/specpath
@@ -33,7 +40,7 @@ later on.
config-suffix =
END
-Make some skeleton directories and files:
+Make some skeleton directories and files::
mkdir -p /mychroot/etc/{env.d,paludis/repositories}
mkdir -p /mychroot/var/{db/pkg,paludis/repositories/gentoo/distfiles}
@@ -41,7 +48,7 @@ Make some skeleton directories and files:
touch /mychroot/etc/ld.so.conf
Set up your keywords.conf. At the very least, you'll need a "* keywords" line.
-Further lines can be added in the form "atom keywords".
+Further lines can be added in the form "atom keywords"::
cat <<END > /mychroot/etc/paludis/keywords.conf
* x86
@@ -55,14 +62,14 @@ Further lines can be added in the form "atom keywords".
Set up your use.conf. At the very least, you'll need a "* flags" line. Again,
additional per-atom lines can be specified. The -apache2 is important, if you
-value your sanity, since you'll be installing subversion.
+value your sanity, since you'll be installing subversion::
cat <<END > /mychroot/etc/paludis/use.conf
* -doc nls unicode -apache2
app-editors/vim -nls
END
-Set up your package_unmask.conf and package_mask.conf, if necessary:
+Set up your package_unmask.conf and package_mask.conf, if necessary::
cat <<END > /mychroot/etc/paludis/package_unmask.conf
app-editors/vim
@@ -72,7 +79,7 @@ Set up your package_unmask.conf and package_mask.conf, if necessary:
Set up your bashrc. This must NOT be used to change any values that affect
dependency resolution (e.g. USE, LINGUAS). It can be used to set CFLAGS, CHOST
and the like (on some archs you'll have to do this to avoid getting junk from
-your profile):
+your profile)::
cat <<END > /mychroot/etc/paludis/bashrc
export CFLAGS="-O2 -march=pentium4 -fomit-frame-pointer"
@@ -84,7 +91,7 @@ Set up your repository files. Do not tinker with the VDB location! Here we'll
avoid using /usr/portage for the main tree because sticking data that gets
changed on /usr is silly. We use the ${ROOT} variable, which is set magically,
to make the config work both in and outside of a chroot (this is one of the
-reasons we have the weird-looking specpath thing).
+reasons we have the weird-looking specpath thing)::
cat <<END > /mychroot/etc/paludis/repositories/gentoo.conf
location = \${ROOT}/var/paludis/repositories/gentoo/
@@ -109,13 +116,13 @@ reasons we have the weird-looking specpath thing).
importance = 10
END
-Now check that the config looks ok, and sync:
+Now check that the config looks ok, and sync::
paludis --config-suffix bootstrap --list-repositories
sudo paludis --config-suffix bootstrap --sync
If you have problems, try adding "--log-level debug". This may or may not give
-helpful information...
+helpful information....
The initial sync will be slow. You can cheat and copy an existing Portage tree
checkout into /mychroot/var/paludis/repositories/gentoo/, but remember to
@@ -132,9 +139,11 @@ Unfortunately, various system packages have broken test suites, so the system
install will probably bomb out midway unless you export SKIP_FUNCTIONS=test
beforehand.
-Also note that there're a whole load of circular dependencies in system (ncurses
-<-> gpm, patch <-> patch, gcc <-> glibc for example), so you'll almost certainly
-need --dl-drop-circular at this stage.
+Also note that there're a whole load of circular dependencies in system
+(ncurses <-> gpm, patch <-> patch, gcc <-> glibc for example), so you'll
+almost certainly need --dl-drop-circular at this stage.
+
+::
paludis --config-suffix bootstrap --install --pretend --dl-drop-all sys-apps/baselayout
sudo paludis --config-suffix bootstrap --install --dl-drop-all sys-apps/baselayout
@@ -143,12 +152,12 @@ need --dl-drop-circular at this stage.
sudo paludis --config-suffix bootstrap --install --dl-drop-circular system
Note that system will pull in Portage. That's a profiles thing that's
-unavoidable for now. It won't pull in Paludis, so we do that manually:
+unavoidable for now. It won't pull in Paludis, so we do that manually::
paludis --config-suffix bootstrap --install --pretend sys-apps/paludis
sudo paludis --config-suffix bootstrap --install sys-apps/paludis
-And that should (but probably won't) give you a usable chroot.
+And that should (but probably won't) give you a usable chroot::
sudo cp /etc/resolv.conf /mychroot/etc/
sudo chroot /mychroot
@@ -166,4 +175,5 @@ And that should (but probably won't) give you a usable chroot.
paludis --uninstall app-editors/nano
paludis --uninstall sys-apps/portage
-vim: set et sw=4 spell spelllang=en :
+.. vim: set et sw=4 spell spelllang=en ft=glep :
+
diff --git a/doc/Makefile.am b/doc/Makefile.am
index c38e2cc..aa28732 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -11,7 +11,7 @@ docfiles = \
doc_licence.doxygen \
doc_authors.doxygen
-EXTRA_DIST = doxygen.conf.in $(docfiles) HOWTO.txt
+EXTRA_DIST = doxygen.conf.in $(docfiles) HOWTO.rst
if HAVE_DOXYGEN