From fa8c64ec29e2250f71e93faef059e1096f50e3eb Mon Sep 17 00:00:00 2001 From: David Sterba Date: Tue, 17 May 2022 23:11:03 +0200 Subject: [PATCH] btrfs-progs: docs: convert Experimental.md to RST Signed-off-by: David Sterba --- .../{Experimental.md => Experimental.rst} | 15 ++++++++++----- Documentation/index.rst | 1 + 2 files changed, 11 insertions(+), 5 deletions(-) rename Documentation/{Experimental.md => Experimental.rst} (61%) diff --git a/Documentation/Experimental.md b/Documentation/Experimental.rst similarity index 61% rename from Documentation/Experimental.md rename to Documentation/Experimental.rst index bf3f31e4..1ace10ef 100644 --- a/Documentation/Experimental.md +++ b/Documentation/Experimental.rst @@ -11,6 +11,8 @@ filed as issues. In the code use it like: +.. code-block:: + if (EXPERIMENTAL) { ... } @@ -20,16 +22,19 @@ where it would break default build. Or: +.. code-block:: + #if EXPERIMENTAL ... #endif for larger code blocks. -Do not use `#ifdef` as the macro is always defined so this would not work as -expected. +.. note:: + 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 -[experimental](https://github.com/kdave/btrfs-progs/labels/experimental), with -a description and a todo list items. Individual tasks can be tracked in other +Each feature should be tracked in an issue with label **experimental** (list of +active issues https://github.com/kdave/btrfs-progs/labels/experimental), with a +description and a todo list items. Individual tasks can be tracked in other issues if needed. diff --git a/Documentation/index.rst b/Documentation/index.rst index fd430805..3cadc907 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -51,3 +51,4 @@ Welcome to BTRFS documentation! Interoperability project-index trouble-index + Experimental