docs: list: fix unintended block quote

This commit is contained in:
Marian Beermann 2017-06-18 02:10:10 +02:00
parent 48e815883f
commit 125b02c5c8
2 changed files with 56 additions and 64 deletions

View File

@ -67,66 +67,58 @@ See the "borg help patterns" command for more help on exclude patterns.
The following keys are available for ``--format``: The following keys are available for ``--format``:
- NEWLINE: OS dependent line separator - NEWLINE: OS dependent line separator
- NL: alias of NEWLINE - NL: alias of NEWLINE
- NUL: NUL character for creating print0 / xargs -0 like output, see barchive/bpath - NUL: NUL character for creating print0 / xargs -0 like output, see barchive/bpath
- SPACE - SPACE
- TAB - TAB
- CR - CR
- LF - LF
Keys for listing repository archives: Keys for listing repository archives:
- archive, name: archive name interpreted as text (might be missing non-text characters, see barchive) - archive, name: archive name interpreted as text (might be missing non-text characters, see barchive)
- barchive: verbatim archive name, can contain any character except NUL - barchive: verbatim archive name, can contain any character except NUL
- time: time of creation of the archive - time: time of creation of the archive
- id: internal ID of the archive - id: internal ID of the archive
Keys for listing archive files: Keys for listing archive files:
- type - type
- mode - mode
- uid - uid
- gid - gid
- user - user
- group - group
- path: path interpreted as text (might be missing non-text characters, see bpath) - path: path interpreted as text (might be missing non-text characters, see bpath)
- bpath: verbatim POSIX path, can contain any character except NUL - bpath: verbatim POSIX path, can contain any character except NUL
- source: link target for links (identical to linktarget) - source: link target for links (identical to linktarget)
- linktarget - linktarget
- flags - flags
- size - size
- csize: compressed size - csize: compressed size
- dsize: deduplicated size - dsize: deduplicated size
- dcsize: deduplicated compressed size - dcsize: deduplicated compressed size
- num_chunks: number of chunks in this file - num_chunks: number of chunks in this file
- unique_chunks: number of unique chunks in this file - unique_chunks: number of unique chunks in this file
- mtime - mtime
- ctime - ctime
- atime - atime
- isomtime - isomtime
- isoctime - isoctime
- isoatime - isoatime
- blake2b - md5
- blake2s - sha1
- md5 - sha224
- sha1 - sha256
- sha224 - sha384
- sha256 - sha512
- sha384
- sha3_224
- sha3_256
- sha3_384
- sha3_512
- sha512
- shake_128
- shake_256
- archiveid - archiveid
- archivename - archivename
- extra: prepends {source} with " -> " for soft links and " link to " for hard links - extra: prepends {source} with " -> " for soft links and " link to " for hard links
- health: either "healthy" (file ok) or "broken" (if file has all-zero replacement chunks) - health: either "healthy" (file ok) or "broken" (if file has all-zero replacement chunks)

View File

@ -1507,13 +1507,13 @@ class BaseFormatter:
@staticmethod @staticmethod
def keys_help(): def keys_help():
return " - NEWLINE: OS dependent line separator\n" \ return "- NEWLINE: OS dependent line separator\n" \
" - NL: alias of NEWLINE\n" \ "- NL: alias of NEWLINE\n" \
" - NUL: NUL character for creating print0 / xargs -0 like output, see barchive/bpath\n" \ "- NUL: NUL character for creating print0 / xargs -0 like output, see barchive/bpath\n" \
" - SPACE\n" \ "- SPACE\n" \
" - TAB\n" \ "- TAB\n" \
" - CR\n" \ "- CR\n" \
" - LF" "- LF"
class ArchiveFormatter(BaseFormatter): class ArchiveFormatter(BaseFormatter):
@ -1535,10 +1535,10 @@ class ArchiveFormatter(BaseFormatter):
@staticmethod @staticmethod
def keys_help(): def keys_help():
return " - archive, name: archive name interpreted as text (might be missing non-text characters, see barchive)\n" \ return "- archive, name: archive name interpreted as text (might be missing non-text characters, see barchive)\n" \
" - barchive: verbatim archive name, can contain any character except NUL\n" \ "- barchive: verbatim archive name, can contain any character except NUL\n" \
" - time: time of creation of the archive\n" \ "- time: time of creation of the archive\n" \
" - id: internal ID of the archive" "- id: internal ID of the archive"
class ItemFormatter(BaseFormatter): class ItemFormatter(BaseFormatter):
@ -1590,7 +1590,7 @@ class ItemFormatter(BaseFormatter):
for group in cls.KEY_GROUPS: for group in cls.KEY_GROUPS:
for key in group: for key in group:
keys.remove(key) keys.remove(key)
text = " - " + key text = "- " + key
if key in cls.KEY_DESCRIPTIONS: if key in cls.KEY_DESCRIPTIONS:
text += ": " + cls.KEY_DESCRIPTIONS[key] text += ": " + cls.KEY_DESCRIPTIONS[key]
help.append(text) help.append(text)