From 5ce269fd41754007270c9053cb9567a78d422c69 Mon Sep 17 00:00:00 2001 From: Thomas Brinker Date: Wed, 9 Jan 2013 16:05:10 +0100 Subject: [PATCH] man-pages: Create/rework tool related manpages --- doc/man/e2-build.1 | 95 ------------ doc/man/e2-build.1.in | 95 ++++++++++++ doc/man/e2-cf.1 | 64 -------- doc/man/e2-cf.1.in | 72 +++++++++ doc/man/e2-create-project.1 | 49 ------ doc/man/e2-create-project.1.in | 49 ++++++ doc/man/e2-dlist.1 | 47 ------ doc/man/e2-dlist.1.in | 34 ++++ doc/man/e2-dsort.1 | 40 ----- doc/man/e2-dsort.1.in | 29 ++++ doc/man/e2-fetch-project.1 | 51 ------ doc/man/e2-fetch-project.1.in | 51 ++++++ doc/man/e2-fetch-sources.1 | 58 ------- doc/man/e2-fetch-sources.1.in | 85 ++++++++++ doc/man/e2-install-e2.1 | 56 ------- doc/man/e2-install-e2.1.in | 29 ++++ doc/man/e2-locate-project-root.1.in | 28 ++++ doc/man/e2-ls-project.1 | 53 ------- doc/man/e2-ls-project.1.in | 51 ++++++ .../{e2-new-source.1 => e2-new-source.1.in} | 69 +++++---- doc/man/e2-playground.1 | 49 ------ doc/man/e2-playground.1.in | 43 ++++++ doc/man/e2.1 | 48 ------ doc/man/e2global.7 | 41 ----- doc/man/e2intro.7 | 146 ------------------ doc/man/e2workflow.7 | 90 ----------- doc/man/man-template.1 | 36 ----- 27 files changed, 604 insertions(+), 954 deletions(-) delete mode 100644 doc/man/e2-build.1 create mode 100644 doc/man/e2-build.1.in delete mode 100644 doc/man/e2-cf.1 create mode 100644 doc/man/e2-cf.1.in delete mode 100644 doc/man/e2-create-project.1 create mode 100644 doc/man/e2-create-project.1.in delete mode 100644 doc/man/e2-dlist.1 create mode 100644 doc/man/e2-dlist.1.in delete mode 100644 doc/man/e2-dsort.1 create mode 100644 doc/man/e2-dsort.1.in delete mode 100644 doc/man/e2-fetch-project.1 create mode 100644 doc/man/e2-fetch-project.1.in delete mode 100644 doc/man/e2-fetch-sources.1 create mode 100644 doc/man/e2-fetch-sources.1.in delete mode 100644 doc/man/e2-install-e2.1 create mode 100644 doc/man/e2-install-e2.1.in create mode 100644 doc/man/e2-locate-project-root.1.in delete mode 100644 doc/man/e2-ls-project.1 create mode 100644 doc/man/e2-ls-project.1.in rename doc/man/{e2-new-source.1 => e2-new-source.1.in} (52%) delete mode 100644 doc/man/e2-playground.1 create mode 100644 doc/man/e2-playground.1.in delete mode 100644 doc/man/e2.1 delete mode 100644 doc/man/e2global.7 delete mode 100644 doc/man/e2intro.7 delete mode 100644 doc/man/e2workflow.7 delete mode 100644 doc/man/man-template.1 diff --git a/doc/man/e2-build.1 b/doc/man/e2-build.1 deleted file mode 100644 index b2e24f0..0000000 --- a/doc/man/e2-build.1 +++ /dev/null @@ -1,95 +0,0 @@ -.\" Man page for e2-build -.\" -.\" (c)2007, 2008 emlix GmbH -.\" -.TH e2-build 1 "Dec 1, 2008" "2.2" - -.SH NAME -e2-build \- build results from repository or local sources - -.SH SYNOPSIS -e2-build [OPTION|RESULT ...] - -.SH DESCRIPTION -\fBe2-build\fR builds one or more results, -dependencies are taken into account. -Depending on the intended outcome, different versions of the source -files to use may be retrieved for the build process. -See \fBe2config\fR for a description of the source config file format. - -.SH RETURN VALUE -Normally, exit status is 0. On error, it is non-zero. - -.SH OPTIONS -.TP -.BR \-\-build-mode=MODE -results can be built according to different build modes, as defined by the -(currently builtin) policy module. -A build mode sets the class of sources to take, and influences the buildid, -the dependencies used and the place to store results. -.TP -.BR \-\-branch-mode -build selected results in 'branch' build-mode. -.TP -.BR \-\-wc-mode -build selected results in 'working-copy' build-mode. -.TP -.BR \-\-all -Possibly build all results listed in the dependencies. -This is the default when building from repository sources. -.TP -.BR \-\-playground -Prepare build environment but do not start the build script. The build -environment can later be entered using the \fBe2-playground\fR tool. -.TP -.BR \-\-keep -Do not remove the \fBchroot\fR(1) environment after a build (regardless -of whether it is successful or not). -.TP -.BR \-\-help -Show usage information. - -.P -Valid build modes according to the builtin policy are -\fBworking-copy\fR, \fBtag\fR, \fBrelease\fR and \fBbranch\fR. -\fBtag\fR is the default build mode. \fBrelease\fR is exactly the same -as \fBtag\fR but the results will be stored in a special location on the -server side. (To be archived, separated from lots of results built -for testing.) - -.P -To use the branch from the scm source configuration for selected results -build in 'tag' mode, and select the results to build in branch-mode. - -.SH Examples: -build selected results from their source branches. Dependencies not selected -on the command line are built in the default build-mode. -.IP -e2-build --branch-mode ... -.PP -build a release -.IP -e2-build --build-mode=release -.PP -build -.IP -e2-build -.PP - -For further global options, see \fBe2intro\fR(7). - -.SH BUGS -Doubtless there are many. - -.SH "SEE ALSO" -.BR e2intro (7), -.BR e2-ls-project (1), -.BR e2-playground (1), -.BR e2config (5), -.BR e2-runbuild (1). - -.SH AUTHORS -Gordon Hecker, Oskar Schirmer and Felix Winkelmann - -.SH COPYRIGHT -(c)2007, 2008 emlix GmbH diff --git a/doc/man/e2-build.1.in b/doc/man/e2-build.1.in new file mode 100644 index 0000000..04ee713 --- /dev/null +++ b/doc/man/e2-build.1.in @@ -0,0 +1,95 @@ +.\" Man page for e2-build +.\" +.\" (c)2007, 2008, 2012 emlix GmbH +.\" +.TH e2-build 1 "Oct 26, 2012" "@VERSION@" + +.SH NAME +e2-build \- build results of an e2factory project + +.SH SYNOPSIS +e2-build [