[pacman-dev] [PATCH 1/2] Update repo-add manpage
Add -v, mention delta support (other than -d), and split repo-add-specific options out from those common to repo-add and repo-remove. Signed-off-by: Ray Kohler <ataraxia937@gmail.com> --- doc/repo-add.8.txt | 46 +++++++++++++++++++++++++++------------------- 1 files changed, 27 insertions(+), 19 deletions(-) diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt index 26009f6..9167a40 100644 --- a/doc/repo-add.8.txt +++ b/doc/repo-add.8.txt @@ -10,35 +10,28 @@ repo-add - package database maintenance utility Synopsis -------- -repo-add [-d] [-f] [-q] <path-to-db> <package1> [<package2> ...] +repo-add [-d] [-f] [-q] [-s] [-v] <path-to-db> <package|delta> [<package|delta> ...] -repo-remove [-q] <path-to-db> <packagename> [<packagename2> ...] +repo-remove [-q] [-s] [-v] <path-to-db> <packagename|delta> [<packagename|delta> ...] Description ----------- repo-add and repo-remove are two scripts to help build a package database for packages built with linkman:makepkg[8] and installed with linkman:pacman[8]. +They also handle package deltas produced by linkman:pkgdelta[8]. -repo-add will update a package database by reading a built package file. -Multiple packages to add can be specified on the command line. +repo-add will update a package database by reading a built package or package +delta file. Multiple packages and/or deltas to add can be specified on the +command line. -repo-remove will update a package database by removing the package name -specified on the command line. Multiple packages to remove can be specified -on the command line. +repo-remove will update a package database by removing the package name or +delta specified on the command line. Multiple packages and/or delta to remove +can be specified on the command line. -Options -------- -*-d, \--delta*:: - Automatically generate and add a delta file between the old entry and the - new one, if the old package file is found next to the new one. - -*-f, \--files*:: - Tells repo-add also to create and include a list of the files in the - specified packages. This is useful for creating databases listing all files - in a given sync repository for tools that may use this information. - +Common Options +-------------- *-q, \--quiet*:: Force this program to keep quiet and run silent except for warning and error messages. @@ -49,9 +42,24 @@ Options signature file, using the GPG agent if it is available. The signature file will be the entire filename of the database with a ``.sig'' extension. +*-v, \--verify*:: + Verify the PGP signature of the database before updating the database. + If the signature is invalid, an error is produced and the update does not + proceed. + +repo-add Options +---------------- +*-d, \--delta*:: + Automatically generate and add a delta file between the old entry and the + new one, if the old package file is found next to the new one. + +*-f, \--files*:: + Tells repo-add also to create and include a list of the files in the + specified packages. This is useful for creating databases listing all files + in a given sync repository for tools that may use this information. See Also -------- -linkman:makepkg[8], linkman:pacman[8] +linkman:makepkg[8], linkman:pacman[8], linkman:pkgdelta[8] include::footer.txt[] -- 1.7.4.1
Signed-off-by: Ray Kohler <ataraxia937@gmail.com> --- doc/.gitignore | 1 + doc/Makefile.am | 4 ++++ doc/pkgdelta.8.txt | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 0 deletions(-) create mode 100644 doc/pkgdelta.8.txt diff --git a/doc/.gitignore b/doc/.gitignore index 4c4e158..a7f33e5 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -5,6 +5,7 @@ makepkg.conf.5 pacman.8 pacman-key.8 pacman.conf.5 +pkgdelta.8 repo-add.8 repo-remove.8 vercmp.8 diff --git a/doc/Makefile.am b/doc/Makefile.am index ed9bb00..def58c4 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,6 +8,7 @@ ASCIIDOC_MANS = \ makepkg.8 \ repo-add.8 \ vercmp.8 \ + pkgdelta.8 \ pacman-key.8 \ PKGBUILD.5 \ makepkg.conf.5 \ @@ -21,6 +22,7 @@ HTML_MANPAGES = \ makepkg.8.html \ repo-add.8.html \ vercmp.8.html \ + pkgdelta.8.html \ pacman-key.8.html \ PKGBUILD.5.html \ makepkg.conf.5.html \ @@ -43,6 +45,7 @@ EXTRA_DIST = \ makepkg.8.txt \ repo-add.8.txt \ vercmp.8.txt \ + pkgdelta.8.txt \ pacman-key.8.txt \ PKGBUILD.5.txt \ PKGBUILD-example.txt \ @@ -136,6 +139,7 @@ pacman.8 pacman.8.html: pacman.8.txt makepkg.8 makepkg.8.html: makepkg.8.txt repo-add.8 repo-add.8.html: repo-add.8.txt vercmp.8 vercmp.8.html: vercmp.8.txt +pkgdelta.8 pkgdelta.8.html: pkgdelta.8.txt pacman-key.8 pacman-key.8.html: pacman-key.8.txt PKGBUILD.5 PKGBUILD.5.html: PKGBUILD.5.txt PKGBUILD-example.txt makepkg.conf.5 makepkg.conf.5.html: makepkg.conf.5.txt diff --git a/doc/pkgdelta.8.txt b/doc/pkgdelta.8.txt new file mode 100644 index 0000000..e6f5c45 --- /dev/null +++ b/doc/pkgdelta.8.txt @@ -0,0 +1,37 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet: +///// +pkgdelta(8) +========= + +Name +---- +pkgdelta - package delta generation utility + + +Synopsis +-------- +'pkgdelta' [-q] <package1> <package2> + + +Description +----------- +'pkgdelta' is used to create package delta files between two versions of the same package. These files are essentially binary patches. linkman:pacman[8] can download deltas instead of full package upgrades, and use them with the previous versions of packages (in the package cache) to synthesize the upgraded version of the packages. This likely reduces download sizes for upgrades significantly. + +'pkgdelta' requires linkman:xdelta3[1] to do its job. + +Options +------- +*-q, \--quiet*:: + Be quiet. Do not output anything but warnings and errors. + +Examples +-------- + + $ pkgdelta libreoffice-3.3.2-1-x86_64.pkg.tar.xz libreoffice-3.3.2-2-x86_64.pkg.tar.xz + +See Also +-------- +linkman:pacman[8], linkman:xdelta3[1] + +include::footer.txt[] -- 1.7.4.1
On Fri, Mar 25, 2011 at 7:26 PM, Ray Kohler <ataraxia937@gmail.com> wrote:
Signed-off-by: Ray Kohler <ataraxia937@gmail.com> --- doc/.gitignore | 1 + doc/Makefile.am | 4 ++++ doc/pkgdelta.8.txt | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 0 deletions(-) create mode 100644 doc/pkgdelta.8.txt
diff --git a/doc/.gitignore b/doc/.gitignore index 4c4e158..a7f33e5 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -5,6 +5,7 @@ makepkg.conf.5 pacman.8 pacman-key.8 pacman.conf.5 +pkgdelta.8 repo-add.8 repo-remove.8 vercmp.8 diff --git a/doc/Makefile.am b/doc/Makefile.am index ed9bb00..def58c4 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,6 +8,7 @@ ASCIIDOC_MANS = \ makepkg.8 \ repo-add.8 \ vercmp.8 \ + pkgdelta.8 \ pacman-key.8 \ PKGBUILD.5 \ makepkg.conf.5 \ @@ -21,6 +22,7 @@ HTML_MANPAGES = \ makepkg.8.html \ repo-add.8.html \ vercmp.8.html \ + pkgdelta.8.html \ pacman-key.8.html \ PKGBUILD.5.html \ makepkg.conf.5.html \ @@ -43,6 +45,7 @@ EXTRA_DIST = \ makepkg.8.txt \ repo-add.8.txt \ vercmp.8.txt \ + pkgdelta.8.txt \ pacman-key.8.txt \ PKGBUILD.5.txt \ PKGBUILD-example.txt \ @@ -136,6 +139,7 @@ pacman.8 pacman.8.html: pacman.8.txt makepkg.8 makepkg.8.html: makepkg.8.txt repo-add.8 repo-add.8.html: repo-add.8.txt vercmp.8 vercmp.8.html: vercmp.8.txt +pkgdelta.8 pkgdelta.8.html: pkgdelta.8.txt pacman-key.8 pacman-key.8.html: pacman-key.8.txt PKGBUILD.5 PKGBUILD.5.html: PKGBUILD.5.txt PKGBUILD-example.txt makepkg.conf.5 makepkg.conf.5.html: makepkg.conf.5.txt diff --git a/doc/pkgdelta.8.txt b/doc/pkgdelta.8.txt new file mode 100644 index 0000000..e6f5c45 --- /dev/null +++ b/doc/pkgdelta.8.txt @@ -0,0 +1,37 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet: +///// +pkgdelta(8) +========= + +Name +---- +pkgdelta - package delta generation utility + + +Synopsis +-------- +'pkgdelta' [-q] <package1> <package2> + + +Description +----------- +'pkgdelta' is used to create package delta files between two versions of the same package. These files are essentially binary patches. linkman:pacman[8] can download deltas instead of full package upgrades, and use them with the previous versions of packages (in the package cache) to synthesize the upgraded version of the packages. This likely reduces download sizes for upgrades significantly. Linewrap at 80 next time, I did it for you when applying this.
+ +'pkgdelta' requires linkman:xdelta3[1] to do its job. + +Options +------- +*-q, \--quiet*:: + Be quiet. Do not output anything but warnings and errors. + +Examples +-------- + + $ pkgdelta libreoffice-3.3.2-1-x86_64.pkg.tar.xz libreoffice-3.3.2-2-x86_64.pkg.tar.xz + +See Also +-------- +linkman:pacman[8], linkman:xdelta3[1] + +include::footer.txt[] -- 1.7.4.1
On Sun, Mar 27, 2011 at 10:23 PM, Dan McGee <dpmcgee@gmail.com> wrote:
On Fri, Mar 25, 2011 at 7:26 PM, Ray Kohler <ataraxia937@gmail.com> wrote:
+'pkgdelta' is used to create package delta files between two versions of the same package. These files are essentially binary patches. linkman:pacman[8] can download deltas instead of full package upgrades, and use them with the previous versions of packages (in the package cache) to synthesize the upgraded version of the packages. This likely reduces download sizes for upgrades significantly. Linewrap at 80 next time, I did it for you when applying this.
I actually thought I had done so - I confused vim's "soft" linewrapping with "real" linewrapping.
participants (2)
-
Dan McGee
-
Ray Kohler