diff options
author | Thomas Lamprecht | 2022-11-29 17:41:44 +0100 |
---|---|---|
committer | Thomas Lamprecht | 2022-11-29 17:41:44 +0100 |
commit | 5638ce3dae97c5e517f79190f805952e3672e10e (patch) | |
tree | ded619b1f6cc1e87f21a10c363b4e9ea35dd3311 | |
parent | a534859b05b08e56c92cc8dcd36f45f12af7a67a (diff) | |
download | aur-5638ce3dae97c5e517f79190f805952e3672e10e.tar.gz |
update to reworked man-page generation in 2.3
Signed-off-by: Thomas Lamprecht <thomas@lamprecht.org>
-rw-r--r-- | .SRCINFO | 3 | ||||
-rw-r--r-- | 0002-docs-drop-all-but-client-man-pages.patch | 69 | ||||
-rw-r--r-- | PKGBUILD | 9 |
3 files changed, 78 insertions, 3 deletions
@@ -12,6 +12,7 @@ pkgbase = proxmox-backup-client makedepends = llvm makedepends = patchelf makedepends = python-docutils + makedepends = python-sphinx depends = acl depends = fuse3 depends = gcc-libs @@ -21,6 +22,7 @@ pkgbase = proxmox-backup-client source = proxmox-fuse::git://git.proxmox.com/git/proxmox-fuse.git source = pxar::git://git.proxmox.com/git/pxar.git source = 0001-re-route-dependencies-not-available-on-crates.io-to-.patch + source = 0002-docs-drop-all-but-client-man-pages.patch source = elf-strip-unused-dependencies.sh sha512sums = SKIP sha512sums = SKIP @@ -28,5 +30,6 @@ pkgbase = proxmox-backup-client sha512sums = SKIP sha512sums = SKIP sha512sums = SKIP + sha512sums = SKIP pkgname = proxmox-backup-client diff --git a/0002-docs-drop-all-but-client-man-pages.patch b/0002-docs-drop-all-but-client-man-pages.patch new file mode 100644 index 000000000000..392f5755f56a --- /dev/null +++ b/0002-docs-drop-all-but-client-man-pages.patch @@ -0,0 +1,69 @@ +From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 +From: Thomas Lamprecht <thomas@lamprecht.org> +Date: Tue, 29 Nov 2022 17:20:28 +0100 +Subject: [PATCH] docs: drop all but client man pages + +Signed-off-by: Thomas Lamprecht <thomas@lamprecht.org> +--- + docs/conf.py | 18 ------------------ + 1 file changed, 18 deletions(-) + +diff --git a/docs/conf.py b/docs/conf.py +index 59f27c42..deeb63bf 100644 +--- a/docs/conf.py ++++ b/docs/conf.py +@@ -93,25 +93,7 @@ rst_epilog += f"\n.. |pbs-copyright| replace:: Copyright (C) {copyright}" + man_pages = [ + # CLI + ('proxmox-backup-client/man1', 'proxmox-backup-client', 'Command line tool for Backup and Restore', [author], 1), +- ('proxmox-backup-manager/man1', 'proxmox-backup-manager', 'Command line tool to manage and configure the backup server.', [author], 1), +- ('proxmox-backup-debug/man1', 'proxmox-backup-debug', 'Debugging command line tool for Backup and Restore', [author], 1), +- ('proxmox-backup-proxy/man1', 'proxmox-backup-proxy', 'Proxmox Backup Public API Server', [author], 1), +- ('proxmox-backup/man1', 'proxmox-backup', 'Proxmox Backup Local API Server', [author], 1), +- ('proxmox-file-restore/man1', 'proxmox-file-restore', 'CLI tool for restoring files and directories from Proxmox Backup Server archives', [author], 1), +- ('proxmox-tape/man1', 'proxmox-tape', 'Proxmox Tape Backup CLI Tool', [author], 1), + ('pxar/man1', 'pxar', 'Proxmox File Archive CLI Tool', [author], 1), +- ('pmt/man1', 'pmt', 'Control Linux Tape Devices', [author], 1), +- ('pmtx/man1', 'pmtx', 'Control SCSI media changer devices (tape autoloaders)', [author], 1), +- # configs +- ('config/acl/man5', 'acl.cfg', 'Access Control Configuration', [author], 5), +- ('config/datastore/man5', 'datastore.cfg', 'Datastore Configuration', [author], 5), +- ('config/media-pool/man5', 'media-pool.cfg', 'Media Pool Configuration', [author], 5), +- ('config/remote/man5', 'remote.cfg', 'Remote Server Configuration', [author], 5), +- ('config/sync/man5', 'sync.cfg', 'Synchronization Job Configuration', [author], 5), +- ('config/tape-job/man5', 'tape-job.cfg', 'Tape Job Configuration', [author], 5), +- ('config/tape/man5', 'tape.cfg', 'Tape Drive and Changer Configuration', [author], 5), +- ('config/user/man5', 'user.cfg', 'User Configuration', [author], 5), +- ('config/verification/man5', 'verification.cfg', 'Verification Job Configuration', [author], 5), + ] + + +diff --git a/docs/Makefile b/docs/Makefile +index b1ce4f7a..87cfe324 100644 +--- a/docs/Makefile ++++ b/docs/Makefile +@@ -1,24 +1,9 @@ + include ../defines.mk + + GENERATED_SYNOPSIS := \ +- proxmox-tape/synopsis.rst \ + proxmox-backup-client/synopsis.rst \ + proxmox-backup-client/catalog-shell-synopsis.rst \ +- proxmox-backup-manager/synopsis.rst \ +- proxmox-backup-debug/synopsis.rst \ +- proxmox-file-restore/synopsis.rst \ + pxar/synopsis.rst \ +- pmtx/synopsis.rst \ +- pmt/synopsis.rst \ +- config/media-pool/config.rst \ +- config/tape/config.rst \ +- config/tape-job/config.rst \ +- config/user/config.rst \ +- config/remote/config.rst \ +- config/sync/config.rst \ +- config/verification/config.rst \ +- config/acl/roles.rst \ +- config/datastore/config.rst + + MAN1_PAGES := \ + pxar.1 \ @@ -13,13 +13,14 @@ depends=( 'gcc-libs' 'openssl' ) -makedepends=('cargo' 'clang' 'git' 'llvm' 'patchelf' 'python-docutils') +makedepends=('cargo' 'clang' 'git' 'llvm' 'patchelf' 'python-docutils' 'python-sphinx') source=( "$pkgname-$pkgver::git://git.proxmox.com/git/proxmox-backup.git#tag=v$pkgver" "proxmox::git://git.proxmox.com/git/proxmox.git#commit=43b4440ef015d846161657490b18cf6ac7600fc4" "proxmox-fuse::git://git.proxmox.com/git/proxmox-fuse.git" "pxar::git://git.proxmox.com/git/pxar.git" "0001-re-route-dependencies-not-available-on-crates.io-to-.patch" + "0002-docs-drop-all-but-client-man-pages.patch" "elf-strip-unused-dependencies.sh" ) # either a git repo or tracked by this git repo, so not much gained by encoding @@ -31,6 +32,7 @@ sha512sums=( 'SKIP' 'SKIP' 'SKIP' + 'SKIP' ) _apply() { @@ -43,6 +45,7 @@ prepare() { rm .cargo/config # drop Debian-style redirect of crates.io to local registry _apply 0001-re-route-dependencies-not-available-on-crates.io-to-.patch + _apply 0002-docs-drop-all-but-client-man-pages.patch # fetch all in prepare to allow build() to be run offline cargo fetch --target "$CARCH-unknown-linux-gnu" @@ -87,8 +90,8 @@ package() { install -Dm755 "target/release/proxmox-backup-client" "$pkgdir/usr/bin/proxmox-backup-client" install -Dm755 "target/release/pxar" "$pkgdir/usr/bin/pxar" - install -Dm644 "docs/proxmox-backup-client.1" "$pkgdir/usr/share/man/man1/proxmox-backup-client.1" - install -Dm644 "docs/pxar.1" "$pkgdir/usr/share/man/man1/pxar.1" + install -Dm644 "docs/output/man/proxmox-backup-client.1" "$pkgdir/usr/share/man/man1/proxmox-backup-client.1" + install -Dm644 "docs/output/man/pxar.1" "$pkgdir/usr/share/man/man1/pxar.1" install -Dm644 "debian/proxmox-backup-client.bc" "$pkgdir/usr/share/bash-completion/completions/proxmox-backup-client" install -Dm644 "debian/pxar.bc" "$pkgdir/usr/share/bash-completion/completions/pxar" |