RepoMirrors/btrfs-progs
1
0
Fork 0
mirror of https://github.com/kdave/btrfs-progs synced 2025-04-27 21:47:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

btrfs-progs: docs: convert Experimental.md to RST

Browse Source 
Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2022-05-17 23:11:03 +02:00
parent 90850c26fa
commit fa8c64ec29
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/Experimental.md → Documentation/Experimental.rst
View File

@ -11,6 +11,8 @@ filed as issues.
In the code use it like: In the code use it like:
.. code-block::
if (EXPERIMENTAL) { if (EXPERIMENTAL) {
... ...
} }
@ -20,16 +22,19 @@ where it would break default build.
Or: Or:
.. code-block::
#if EXPERIMENTAL #if EXPERIMENTAL
... ...
#endif #endif
for larger code blocks. for larger code blocks.
Do not use `#ifdef` as the macro is always defined so this would not work as .. note::
expected. Do not use `#ifdef` as the macro is always defined so this would not work as
expected.
Each feature should be tracked in an issue with label Each feature should be tracked in an issue with label **experimental** (list of
[experimental](https://github.com/kdave/btrfs-progs/labels/experimental), with active issues https://github.com/kdave/btrfs-progs/labels/experimental), with a
a description and a todo list items. Individual tasks can be tracked in other description and a todo list items. Individual tasks can be tracked in other
issues if needed. issues if needed.

1
Documentation/index.rst
View File

@ -51,3 +51,4 @@ Welcome to BTRFS documentation!
Interoperability Interoperability
project-index project-index
trouble-index trouble-index
Experimental