From c5e41484150403547a1d0db8151b3a0d5bf6b80b Mon Sep 17 00:00:00 2001 From: Guido Günther Date: Sun, 22 Nov 2009 17:01:02 +0100 Subject: Add documentation for gbp-{pg,pull.clone} --- debian/rules | 2 +- docs/common.ent | 3 ++ docs/man.gbp-clone.sgml | 11 +++++ docs/man.gbp-pq.sgml | 11 +++++ docs/man.gbp-pull.sgml | 11 +++++ docs/manpages/gbp-clone.sgml | 97 ++++++++++++++++++++++++++++++++++++ docs/manpages/gbp-pq.sgml | 47 ++++++++++++++++++ docs/manpages/gbp-pull.sgml | 114 +++++++++++++++++++++++++++++++++++++++++++ docs/manpages/manpages.ent | 3 ++ docs/manual.sgml | 3 ++ 10 files changed, 301 insertions(+), 1 deletion(-) create mode 100644 docs/man.gbp-clone.sgml create mode 100644 docs/man.gbp-pq.sgml create mode 100644 docs/man.gbp-pull.sgml create mode 100644 docs/manpages/gbp-clone.sgml create mode 100644 docs/manpages/gbp-pq.sgml create mode 100644 docs/manpages/gbp-pull.sgml diff --git a/debian/rules b/debian/rules index 60da789..5c53056 100755 --- a/debian/rules +++ b/debian/rules @@ -18,7 +18,7 @@ EXAMPLE_SCRIPTS=gbp-cowbuilder-sid gbp-pbuilder gbp-posttag-push DEB_COMPRESS_EXCLUDE=$(EXAMPLE_SCRIPTS) -MANPAGES=$(patsubst %,docs/%.1,$(COMMANDS)) +MANPAGES=$(patsubst %,docs/%.1,$(COMMANDS) gbp-pq) MANUAL=docs/manual-html PYCHECKS=$(patsubst %,%.py,$(COMMANDS)) PYCHECK_LEVEL=Error diff --git a/docs/common.ent b/docs/common.ent index 3ff5716..ff27a64 100644 --- a/docs/common.ent +++ b/docs/common.ent @@ -8,6 +8,9 @@ git-import-dsc"> git-import-dscs"> git-dch"> + gbp-pull"> + gbp-clone"> + gbp-pq"> git"> gitk"> pbuilder"> diff --git a/docs/man.gbp-clone.sgml b/docs/man.gbp-clone.sgml new file mode 100644 index 0000000..6fa6f56 --- /dev/null +++ b/docs/man.gbp-clone.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +git-buildpackage Manual +&man.gbp.clone; + diff --git a/docs/man.gbp-pq.sgml b/docs/man.gbp-pq.sgml new file mode 100644 index 0000000..093ce2f --- /dev/null +++ b/docs/man.gbp-pq.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +git-buildpackage Manual +&man.gbp.pq; + diff --git a/docs/man.gbp-pull.sgml b/docs/man.gbp-pull.sgml new file mode 100644 index 0000000..b2dedbd --- /dev/null +++ b/docs/man.gbp-pull.sgml @@ -0,0 +1,11 @@ + + %COMMON; + + %MANPAGES; +]> + + +git-buildpackage Manual +&man.gbp.pull; + diff --git a/docs/manpages/gbp-clone.sgml b/docs/manpages/gbp-clone.sgml new file mode 100644 index 0000000..559da83 --- /dev/null +++ b/docs/manpages/gbp-clone.sgml @@ -0,0 +1,97 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp-clone + &dhsection; + + + &gbp-clone; + + Clone a repository from remote + + + + &gbp-clone; + + + + branch_name + branch_name + remote_uri + + + + DESCRIPTION + + &gbp-clone; clones a remote repository and sets up tracking branches for + the debian, upstream and + pristine-tar branches. This way you can easily update + later using &gbp-pull;. + + + + OPTIONS + + + + =branch_name + + + The branch in the Git repository the Debian package is being + developed on, default is master. + + + + =branch_name + + + The branch in the &git; repository the upstream sources are put + onto. Default is upstream. + + + + + + + verbose execution + + + + + + + generate pristine-tar delta file + + + + + &man.git.config-files; + + + SEE ALSO + + + git-buildpackage + 1 + , + + gbp-pull + 1 + + + + + AUTHOR + + &dhusername; &dhemail; + + + diff --git a/docs/manpages/gbp-pq.sgml b/docs/manpages/gbp-pq.sgml new file mode 100644 index 0000000..f1fcb20 --- /dev/null +++ b/docs/manpages/gbp-pq.sgml @@ -0,0 +1,47 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp-pq + &dhsection; + + + &gbp-pq; + + Manage quilt patches on a patch-queue branch + + + + &gbp-pq; + ||| + + + + DESCRIPTION + + See for documentation. + + + + SEE ALSO + + + git-buildpackage + 1 + , + + + + AUTHOR + + &dhusername; &dhemail; + + + diff --git a/docs/manpages/gbp-pull.sgml b/docs/manpages/gbp-pull.sgml new file mode 100644 index 0000000..de5ac8c --- /dev/null +++ b/docs/manpages/gbp-pull.sgml @@ -0,0 +1,114 @@ + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + + gbp-pull + &dhsection; + + + &gbp-pull; + + Safely update a repository from remote + + + + &gbp-pull; + + + + + + branch_name + branch_name + + + + DESCRIPTION + + &gbp-pull; updates the debian, + upstream and pristine-tar + branches from a remote repository in one go. It checks if the update is safe (would + result in a fast-forward merge) and aborts otherwise. + + + + OPTIONS + + + + + + force update even if this results in a non fast forward update + + + + + + also rebuild the corresponding patch-queue using &gbp-pq; + + + + =branch_name + + + The branch in the Git repository the Debian package is being + developed on, default is master. + + + + =branch_name + + + The branch in the &git; repository the upstream sources are put + onto. Default is upstream. + + + + + + + verbose execution + + + + + + + generate pristine-tar delta file + + + + + &man.git.config-files; + + + SEE ALSO + + + git-buildpackage + 1 + , + + gbp-clone + 1 + , + + gbp-pq + 1 + + + + + AUTHOR + + &dhusername; &dhemail; + + + diff --git a/docs/manpages/manpages.ent b/docs/manpages/manpages.ent index 21c5bf0..62115cf 100644 --- a/docs/manpages/manpages.ent +++ b/docs/manpages/manpages.ent @@ -3,5 +3,8 @@ + + + diff --git a/docs/manual.sgml b/docs/manual.sgml index eb97753..7977691 100644 --- a/docs/manual.sgml +++ b/docs/manual.sgml @@ -32,6 +32,9 @@ &man.git.importdscs; &man.git.importorig; &man.git.dch; + &man.gbp.clone; + &man.gbp.pull; + &man.gbp.pq; Copyright -- cgit v1.2.3