mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #4813 from Gu1nness/fix-borg-man-page 

Fix the borg(1) man page creation
This commit is contained in:
TW 2019-11-01 18:09:15 +01:00 committed by GitHub
parent c178ed5977 5bdf998a21
commit 454dbfcaea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/man_intro.rst
View File

@ -1,16 +1,3 @@
====
borg
====
----------------------------------------
deduplicating and encrypting backup tool
----------------------------------------
:Author: The Borg Collective
:Date: 2017-02-05
:Manual section: 1
:Manual group: borg backup tool
SYNOPSIS
--------
@ -65,4 +52,4 @@ SEE ALSO
* Releases https://github.com/borgbackup/borg/releases
* Changelog https://github.com/borgbackup/borg/blob/master/docs/changes.rst
* GitHub https://github.com/borgbackup/borg
* Security contact https://borgbackup.readthedocs.io/en/latest/support.html#security-contact
* Security contact https://borgbackup.readthedocs.io/en/latest/support.html#security-contact

7
setup_docs.py
View File

@ -424,10 +424,15 @@ class build_man(Command):
self.gen_man_page(man_title, doc.getvalue())
def build_intro_page(self):
doc, write = self.new_doc()
man_title = 'borg'
print('building man page borg(1)', file=sys.stderr)
with open('docs/man_intro.rst') as fd:
man_intro = fd.read()
self.gen_man_page('borg', self.rst_prelude + man_intro)
self.write_man_header(write, man_title, "deduplicating and encrypting backup tool")
self.gen_man_page(man_title, doc.getvalue() + man_intro)
def new_doc(self):
doc = io.StringIO(self.rst_prelude)