[jhbuild] Convert README to rst
- From: Christoph Reiter <creiter src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [jhbuild] Convert README to rst
- Date: Thu, 5 Sep 2019 17:24:15 +0000 (UTC)
commit e9d6dee129aab1d89f06ac86a4b865ef42929568
Author: Christoph Reiter <reiter christoph gmail com>
Date: Thu Sep 5 19:11:57 2019 +0200
Convert README to rst
Makefile.am | 1 +
README => README.rst | 86 +++++++++++++++++++++++++---------------------------
2 files changed, 42 insertions(+), 45 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 7744d47b..af0f7778 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -24,6 +24,7 @@ jhbuild.desktop: jhbuild.desktop.in
endif
EXTRA_DIST = $(PATCHES) $(MODULESETS) $(DTDS) \
+ README.rst \
modulesets/moduleset.xsl \
autogen.sh \
jhbuild.desktop.in.in jhbuild.desktop.in
diff --git a/README b/README.rst
similarity index 67%
rename from README
rename to README.rst
index 2b0fc91a..8ddf7796 100644
--- a/README
+++ b/README.rst
@@ -1,5 +1,5 @@
JHBuild README
-================================
+==============
JHBuild is a tool designed to ease building collections of source
packages, called “modules”.
@@ -10,7 +10,7 @@ extended to be usable with other projects.
JHBuild requires Python >= 2.3
Installing JHBuild
------------
+------------------
Refer to the 'Getting Started' section of the JHBuild manual:
@@ -25,21 +25,21 @@ Using JHBuild
JHBuild uses a command line syntax similar to tools like CVS:
- jhbuild [global-options] command [command-arguments]
+**jhbuild [global-options] command [command-arguments]**
The global JHBuild options are:
- -f, --file config
+-f, --file config
Use an alternative configuration file instead of the default
~/.config/jhbuildrc.
- -m, --moduleset moduleset
+-m, --moduleset moduleset
Use a module set other than the module set listed in the
configuration file. This option can be a relative path if the module
set is located in the JHBuild moduleset folder, or an absolute path
if located elsewhere.
- --no-interact
+--no-interact
Do not prompt the user for any input. This option is useful if
leaving a build unattended, in order to ensure the build is not
interrupted.
@@ -47,106 +47,102 @@ The global JHBuild options are:
Refer to the JHBuild manual for a complete list of JHBuild commands
and options. The common ones are:
-jhbuild bootstrap
+**jhbuild bootstrap**
- The bootstrap command installs a set of build utilities. The build
- utilities include autoconf , automake and similar utilities. The
- recommended method to install the build utilities is via your
- distribution's package management system. The bootstrap should only be
- used if the build utilites are not provided by your distribution's package
- management system, for example on Mac OS.
+The bootstrap command installs a set of build utilities. The build
+utilities include autoconf , automake and similar utilities. The
+recommended method to install the build utilities is via your
+distribution's package management system. The bootstrap should only be
+used if the build utilites are not provided by your distribution's package
+management system, for example on Mac OS.
-jhbuild build [--autogen] [--clean] [--dist] [--distcheck]
- [--ignore-suggests] [--no-network] [--skip=module...]
- [--start-at=module] [--tags=tags] [-D date] [--no-xvfb]
- [--try-checkout] [--no-poison] [--force] [--build-optional-modules]
- [--min-age=time] [module...]
+**jhbuild build [--autogen] [--clean] [--dist] [--distcheck] [--ignore-suggests] [--no-network]
[--skip=module...] [--start-at=module] [--tags=tags] [-D date] [--no-xvfb] [--try-checkout] [--no-poison]
[--force] [--build-optional-modules] [--min-age=time] [module...]**
- The build command builds one or more packages, including their
- dependencies.
+The build command builds one or more packages, including their
+dependencies.
- If no module names are provided on the command line, the modules
- list from the configuration file will be used.
+If no module names are provided on the command line, the modules
+list from the configuration file will be used.
- -a, --autogen
+-a, --autogen
Always run autogen.sh before building modules. By default,
autogen.sh will only be called if the top-level makefile is
missing. Otherwise, JHBuild relies on the package's makefiles to
detect if configure needs to be rebuilt or rerun.
- -c, --clean
+-c, --clean
Run make clean before building modules.
- -d, --dist
+-d, --dist
Run make dist after building modules.
- --distcheck
+--distcheck
Run make distcheck after building modules.
- --ignore-suggests
+--ignore-suggests
Do not build soft dependencies.
- -n, --no-network
+-n, --no-network
Do not access the network when building modules. This will skip
download or update stages in a build. If a module can't be built
without network access, the module build will fail.
- -s, --skip=module,...
+-s, --skip=<module,...>
Do not build the listed modules. Used to skip the building of
specified dependencies.
- --tags=tag,...
+--tags=<tag,...>
Ignore modules that do not match tag. Modules are automatically
attributed a tag matching the name of the module's module set.
- -t, --start-at=module
+-t, --start-at=module
Start at the named module rather than at the beginning of the
list. This option is useful if the build was interrupted.
- -D date
+-D date
If supported by the underlying version control system, update the
source tree to the specified date before building. An ISO date
format is required, e.g. "2009-09-18 02:32Z".
- -x, --no-xvfb
+-x, --no-xvfb
Run graphical tests on the actual X server rather than in a
simulated Xvfb.
- -C, --try-checkout
+-C, --try-checkout
If the build fails, and if supported by the version control system,
force a checkout and run autogen.sh before retrying the build.
- -N, --no-poison
+-N, --no-poison
If one or more of a module's dependencies failed, this option forces
JHBuild to try to build the module anyway.
- -f, --force
+-f, --force
Build the modules even if policy states it is not required.
- --build-optional-modules
+--build-optional-modules
Modules listed as optional dependencies, may not be required to
build the module. This option forces JHBuild to build optional
dependencies.
- --min-age=time
+--min-age=time
Skip modules installed more recently than the specified relative
time. The time string format is a number followed by a unit. The
following units are supported: seconds (s), minutes (m), hours (h)
and days (d). For example, --min-age=2h will skip modules built
less than two hours ago.
-jhbuild buildone [--autogen] [--clean] [--distcheck] [--no-network]
- [-D date] [--no-xvfb] [--force] [--min-age=time] module...
+**jhbuild buildone [--autogen] [--clean] [--distcheck] [--no-network] [-D date] [--no-xvfb] [--force]
[--min-age=time] module...**
- The buildone command is similar to build, but it does not build the
- dependent modules. It is useful for rebuilding one or more modules.
+The buildone command is similar to build, but it does not build the
+dependent modules. It is useful for rebuilding one or more modules.
-jhbuild sanitycheck
+**jhbuild sanitycheck**
- The sanitycheck command performs a number of checks to verify the
- build environment is okay.
+The sanitycheck command performs a number of checks to verify the
+build environment is okay.
For details of all jbhuild's command line options:
+
jhbuild --help
Reporting Bugs
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]