RepoMirrors/btrfs-progs
1
0
Fork 0
mirror of https://github.com/kdave/btrfs-progs synced 2025-04-26 04:57:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
5,743 Commits 25 Branches 166 Tags 32 MiB
8742a38d5f
Commit Graph

27 Commits

Author SHA1 Message Date
David Sterba
a079982a9e btrfs-progs: docs: disable RST smartquotes for em-dash 
All long command line options in the html target render as a single
character which is confusing and wrong as we expect that to be '--'.
Disable it.

Signed-off-by: David Sterba <dsterba@suse.com>
 2021-11-18 10:17:21 +01:00
David Sterba
cc8a100c90 btrfs-progs: docs: convert btrfs(5) to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
c52b6d9473 btrfs-progs: docs: convert mkfs.btrfs to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
2ba78e5ed0 btrfs-progs: docs: convert btrfs(8) to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
71b1306fda btrfs-progs: docs: convert btrfs-map-logical to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
f03df4f256 btrfs-progs: docs: convert btrfs-subvolume to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
d3e7d66ae4 btrfs-progs: docs: convert btrfs-balance to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
6b322fd12a btrfs-progs: docs: convert btrfs-check to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
9111518193 btrfs-progs: docs: convert btrfs-convert to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
2685136fa1 btrfs-progs: docs: convert btrfs-device to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
0f6a5c3847 btrfs-progs: docs: convert btrfs-filesystem to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
48b43e0d3a btrfs-progs: docs: convert btrfs-find-root to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
fb9c88fa93 btrfs-progs: docs: convert btrfs-image to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
110d2be843 btrfs-progs: docs: convert btrfs-inspect-internal to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:04 +02:00
David Sterba
26a7720748 btrfs-progs: docs: convert btrfs-property to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
2f947467f6 btrfs-progs: docs: convert btrfs-qgroup to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
7cd4302a57 btrfs-progs: docs: convert btrfs-quota to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
964c94fb81 btrfs-progs: docs: convert btrfs-receive to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
2c7869dc3a btrfs-progs: docs: convert btrfs-replace to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
efaf218a80 btrfs-progs: docs: convert btrfs-rescue to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
0f4f3b0c72 btrfs-progs: docs: convert btrfs-restore to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
0360969430 btrfs-progs: docs: convert btrfs-scrub to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
f3b88e6b75 btrfs-progs: docs: convert btrfs-send to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
e508e6707d btrfs-progs: docs: convert fsck.btrfs to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
df04fbceec btrfs-progs: docs: convert btrfstune to rst 
Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
4110fbc46f btrfs-progs: docs: add sample RSTified manual page 
The asciidoc format needs to be tweaked but otherwise is basically the
same. Changes:

- bold text is ** **
- italics is * *
- NOTE is directive .. note
- definition list is simple indented block after the term
- section NAME in the manual page is generated from date in
  conf.py:man_pages
- new page has to be added to the index

To do:

- references to other manual pages, will be RST native linking once all
  the pages are converted

The output is in Documentation/_build/man and the format is visually not
much different from what is generated by asciidoc.

Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00
David Sterba
86d3904166 btrfs-progs: docs: add sphinx build support 
Add basic config and build files for sphinx. The long term plan is to
convert all asciidoc sources to ReST and host majority of wiki contents,
and maybe more.

Build:

  $ cd Documentation/
  $ make -f Makefile.sphinx html

The result is in Documentation/_build/html.

Signed-off-by: David Sterba <dsterba@suse.com>
 2021-10-29 17:30:03 +02:00