mirror of
https://github.com/kdave/btrfs-progs
synced 2024-12-17 20:05:24 +00:00
2b3d95519e
There are several warnings regarding the absence of an argument for the
code-block directive on some build servers using python3-sphinx 0.2.2-17.
For example:
Making all in Documentation
[SPHINX] man
ch-subvolume-intro.rst:141: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
27 21 0:19 /subv1 /mnt rw,relatime - btrfs /dev/sda rw,space_cache
Etc...
Add the none argument.
[ci skip]
Signed-off-by: Anand Jain <anand.jain@oracle.com>
Signed-off-by: David Sterba <dsterba@suse.com>
41 lines
981 B
ReStructuredText
41 lines
981 B
ReStructuredText
Experimental features
|
|
=====================
|
|
|
|
Experimental or unstable features may be enabled by
|
|
|
|
./configure --enable-experimental
|
|
|
|
but as it says, the interface, command names, output formatting should be considered
|
|
unstable and not for production use. However testing is welcome and feedback or bugs
|
|
filed as issues.
|
|
|
|
In the code use it like:
|
|
|
|
.. code-block:: none
|
|
|
|
if (EXPERIMENTAL) {
|
|
...
|
|
}
|
|
|
|
in case it does not interfere with other code or does not depend on an `#if`
|
|
where it would break default build.
|
|
|
|
Or:
|
|
|
|
.. code-block:: none
|
|
|
|
#if EXPERIMENTAL
|
|
...
|
|
#endif
|
|
|
|
for larger code blocks.
|
|
|
|
.. 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** (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.
|