summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElan Ruusamäe2020-04-30 10:53:33 (GMT)
committerElan Ruusamäe2020-04-30 11:00:20 (GMT)
commit7f4c36220a760b20f8de3e4fc968d244408ec186 (patch)
tree6dd607155473dd68213bd33f3296778c904ea22d
parent3bf22c6f3261b30fd5cf05a224c24b90a71a41c6 (diff)
downloadcleanbuild-7f4c36220a760b20f8de3e4fc968d244408ec186.zip
cleanbuild-7f4c36220a760b20f8de3e4fc968d244408ec186.tar.gz
Use markdown for documentation
-rw-r--r--README.docker.md (renamed from README.docker)2
-rw-r--r--README.md (renamed from README)11
-rw-r--r--README.vserver51
-rw-r--r--README.vserver.md56
4 files changed, 63 insertions, 57 deletions
diff --git a/README.docker b/README.docker.md
index afb7f41..3df89db 100644
--- a/README.docker
+++ b/README.docker.md
@@ -1,4 +1,4 @@
-cleanbuild docker engine
+# cleanbuild docker engine
With docker engine there's nothing needed to configure on local system other
than access to running docker engine and docker client program.
diff --git a/README b/README.md
index a412694..6bfd4bc 100644
--- a/README
+++ b/README.md
@@ -1,4 +1,4 @@
-cleanbuild
+# cleanbuild
cleanbuild is tool to help discovering missing (or excessive) dependencies by
building packages in clean build environment.
@@ -7,12 +7,13 @@ cleanbuild comes with two backends:
- vserver (legacy)
- docker
-See README.vserver or README.docker for engine specific instructions.
+See [vserver](README.vserver.md) or [docker](README.docker.md) for engine specific instructions.
Run cleanbuild:
- ./cleanbuild FHS
+ ./cleanbuild FHS
You can create yourself alias for easier invocation from regular user:
- alias cleanbuild='_cleanbuild() { sudo -H -u builder sh -c "cd ~/cleanbuild && ./cleanbuild $*"; }; _cleanbuild'
- cleanbuild somepkg
+
+ alias cleanbuild='_cleanbuild() { sudo -H -u builder sh -c "cd ~/cleanbuild && ./cleanbuild $*"; }; _cleanbuild'
+ cleanbuild somepkg
diff --git a/README.vserver b/README.vserver
deleted file mode 100644
index 775d3c5..0000000
--- a/README.vserver
+++ /dev/null
@@ -1,51 +0,0 @@
-cleanbuild vserver engine
-
-cleanbuild vserver engine requires vserver with special customizations.
-
-Dependencies:
-
- Missing packages on fresh PLD vserver installation:
-
- git-core
- mount
- perl-base
- poldek
- rpm-build-tools >= 4.5-3
- subversion
- sudo
-
-Setup:
-
- # Install all dependencies
-
- # configure passwordless sudo for user you use for cleanbuild
- visudo
-
- # add something like (assuming you have 'builder' as dedicated account)
- builder ALL=(ALL) NOPASSWD: ALL
- Defaults:builder env_keep += USER
-
- # create rpm dir
- builder --init-rpm-dir
-
- # create directories
- mkdir ~/rpm/cleanRPMS
- mkdir ~/rpm/cleanRPMS.repo
-
- # checkout svn repo
- svn co http://svn.pld-linux.org/svn/toys/tools/cleanbuild
-
- # set local user name
- echo 'USER="builder"' > .cleanbuildrc
-
-Notes for vserver:
-
- If you are inside vserver, you need to have following context capabilities
- (add these lines to /etc/vserver/<name>/ccapabilities):
- SECURE_MOUNT
- BINARY_MOUNT
-
- And following system capabilities (add these lines to
- /etc/vserver/<name>/bcapabilities):
- MKNOD
- SYS_ADMIN
diff --git a/README.vserver.md b/README.vserver.md
new file mode 100644
index 0000000..cfd3ee9
--- /dev/null
+++ b/README.vserver.md
@@ -0,0 +1,56 @@
+# cleanbuild vserver engine
+
+cleanbuild vserver engine requires vserver with special customizations.
+
+Dependencies:
+- git-core
+- mount
+- perl-base
+- poldek
+- rpm-build-tools >= 4.5-3
+- subversion
+- sudo
+
+# Setup
+
+## Install all dependencies
+
+configure passwordless sudo for user you use for cleanbuild
+
+ visudo
+
+add something like (assuming you have 'builder' as dedicated account)
+
+ builder ALL=(ALL) NOPASSWD: ALL
+ Defaults:builder env_keep += USER
+
+create rpm dir
+
+ builder --init-rpm-dir
+
+create directories
+
+ mkdir ~/rpm/cleanRPMS
+ mkdir ~/rpm/cleanRPMS.repo
+
+checkout the repo
+
+ git clone ssh://git@git.pld-linux.org/projects/cleanbuild
+
+set local user name
+
+ echo 'USER="builder"' > .cleanbuildrc
+
+Notes for vserver:
+
+ If you are inside vserver, you need to have following context capabilities
+ (add these lines to `/etc/vserver/<name>/ccapabilities`):
+
+ SECURE_MOUNT
+ BINARY_MOUNT
+
+ And following system capabilities (add these lines to
+ `/etc/vserver/<name>/bcapabilities`):
+
+ MKNOD
+ SYS_ADMIN