RepoMirrors
/
btrfs-progs
mirror of https://github.com/kdave/btrfs-progs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
btrfs-progs/Documentation/index.rst

74 lines
1.1 KiB
ReStructuredText
Raw Normal View History

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-26 21:06:50 +00:00
.. BTRFS documentation master file
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-26 20:48:27 +00:00
Welcome to BTRFS documentation!
===============================
.. toctree::
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-26 21:06:50 +00:00
:maxdepth: 1
btrfs-progs: docs: add more of the new doc structure Add overall structure for now, some contents is from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2021-11-30 15:00:48 +00:00
:caption: Overview
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-26 20:48:27 +00:00
btrfs-progs: docs: add more of the new doc structure Add overall structure for now, some contents is from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2021-11-30 15:00:48 +00:00
Introduction
btrfs-progs: docs: add Status page from wiki Signed-off-by: David Sterba <dsterba@suse.com>
2023-03-17 19:40:30 +00:00
Status
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-26 21:06:50 +00:00
man-index
btrfs-progs: docs: split mount options Signed-off-by: David Sterba <dsterba@suse.com>
2022-01-11 23:09:29 +00:00
Administration
btrfs-progs: docs: separate chapter for hardware considerations Make it more visible than just in section 5. Signed-off-by: David Sterba <dsterba@suse.com>
2022-05-12 18:39:29 +00:00
Hardware
btrfs-progs: docs: add feature by version table from wiki Copy contents from https://btrfs.wiki.kernel.org/index.php/Changelog#By_feature The formatting is done by a definition and list, instead of a table. Unfortunatelly RST does not wrap long text in table cells so the width exceeds visible area. Signed-off-by: David Sterba <dsterba@suse.com>
2022-06-14 18:39:42 +00:00
Feature-by-version
btrfs-progs: docs: add kernel version changes Copy from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2023-03-17 21:18:55 +00:00
Kernel-by-version
btrfs-progs: docs: fixups, references Signed-off-by: David Sterba <dsterba@suse.com>
2023-06-01 18:46:06 +00:00
CHANGES
btrfs-progs: docs: merge project documentation section to overview The links to repositories and contributors is hard to find as it's below the feature list. Move it up as it is for overview. Signed-off-by: David Sterba <dsterba@suse.com>
2023-05-26 16:14:16 +00:00
Contributors
btrfs-progs: docs: move glossary to overview sections The glossary is reasonably complete so make it more visible in the main section. Signed-off-by: David Sterba <dsterba@suse.com>
2022-05-10 13:48:50 +00:00
Glossary
btrfs-progs: docs: link INSTALL to docs The INSTALL format renders fine as RST, add it to the main page. Signed-off-by: David Sterba <dsterba@suse.com>
2022-05-12 11:56:03 +00:00
INSTALL
btrfs-progs: docs: merge project documentation section to overview The links to repositories and contributors is hard to find as it's below the feature list. Move it up as it is for overview. Signed-off-by: David Sterba <dsterba@suse.com>
2023-05-26 16:14:16 +00:00
Source-repositories
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-26 20:48:27 +00:00
btrfs-progs: docs: add more of the new doc structure Add overall structure for now, some contents is from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2021-11-30 15:00:48 +00:00
.. toctree::
:maxdepth: 1
:caption: Features:
Common-features
Custom-ioctls
Auto-repair
Balance
Compression
Checksumming
Convert
Deduplication
Defragmentation
Inline-files
Qgroups
Reflink
Resize
Scrub
Seeding-device
Send-receive
btrfs-progs: docs: add subpage feature page Introductory paragraph, status and progress needs to be added. Signed-off-by: David Sterba <dsterba@suse.com>
2022-05-13 16:54:14 +00:00
Subpage
btrfs-progs: docs: add more of the new doc structure Add overall structure for now, some contents is from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2021-11-30 15:00:48 +00:00
Subvolumes
btrfs-progs: docs: split swapfile from section 5 Signed-off-by: David Sterba <dsterba@suse.com>
2022-01-11 22:56:25 +00:00
Swapfile
btrfs-progs: docs: add more of the new doc structure Add overall structure for now, some contents is from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2021-11-30 15:00:48 +00:00
Tree-checker
Trim
Volume-management
Zoned-mode
btrfs-progs: docs: group developer documentation Add new directory and move ther all exisisting documentation meant for developers. Signed-off-by: David Sterba <dsterba@suse.com>
2023-04-04 22:20:41 +00:00
.. toctree::
:maxdepth: 1
:caption: Developer documentation
btrfs-progs: docs: add Development notes Copied from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2023-04-04 22:56:29 +00:00
dev/Development-notes
btrfs-progs: docs: add Developer's FAQ Copied from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2023-04-04 23:16:52 +00:00
dev/Developer-s-FAQ
btrfs-progs: docs: group developer documentation Add new directory and move ther all exisisting documentation meant for developers. Signed-off-by: David Sterba <dsterba@suse.com>
2023-04-04 22:20:41 +00:00
dev/Experimental
dev/dev-btrfs-design
btrfs-progs: docs: add On disk format Copied from wiki. May contain out of date information and formatting mistakes. Signed-off-by: David Sterba <dsterba@suse.com>
2023-04-04 23:39:42 +00:00
dev/dev-btrees
dev/On-disk-format
btrfs-progs: docs: group developer documentation Add new directory and move ther all exisisting documentation meant for developers. Signed-off-by: David Sterba <dsterba@suse.com>
2023-04-04 22:20:41 +00:00
dev/dev-send-stream
btrfs-progs: docs: add dev docs about json Programmer documentation, to be continued. Signed-off-by: David Sterba <dsterba@suse.com>
2023-08-18 16:14:15 +00:00
dev/dev-json
btrfs-progs: docs: add developer docs for internal APIs Signed-off-by: David Sterba <dsterba@suse.com>
2023-08-21 14:54:01 +00:00
dev/dev-internal-apis
btrfs-progs: docs: group developer documentation Add new directory and move ther all exisisting documentation meant for developers. Signed-off-by: David Sterba <dsterba@suse.com>
2023-04-04 22:20:41 +00:00
btrfs-ioctl
btrfs-progs: docs: add more of the new doc structure Add overall structure for now, some contents is from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2021-11-30 15:00:48 +00:00
.. toctree::
:maxdepth: 1
:caption: TODO
btrfs-progs: docs: add more chapters (part 3) All main pages have some content and many typos have been fixed. Signed-off-by: David Sterba <dsterba@suse.com>
2021-12-17 09:49:39 +00:00
Quick-start
btrfs-progs: docs: add more of the new doc structure Add overall structure for now, some contents is from wiki. Signed-off-by: David Sterba <dsterba@suse.com>
2021-11-30 15:00:48 +00:00
Interoperability
trouble-index
btrfs-progs: docs: fix spinx build warnings Fix the following warnings: [SPHINX] man ../CHANGES:37: ERROR: Unexpected indentation. ../CHANGES:1183: WARNING: Block quote ends without a blank line; unexpected unindent. ./Documentation/DocConventions.rst:31: ERROR: Unexpected indentation. ./Documentation/Source-repositories.rst:2: WARNING: Duplicate explicit target name: "web access". ./Documentation/DocConventions.rst: WARNING: document isn't included in any toctree The free format of CHANGES sometimes does not align with RST so fix it so it's visually similar in both formats. Remove RST references to 'web access', URLs are parsed and rendered clickable and we don't have full reference list yet. Doc conventions have been updated to RST but not finalized so put it to TODO section. Signed-off-by: David Sterba <dsterba@suse.com>
2022-06-13 13:24:21 +00:00
DocConventions