documentation: erasure code profile update

The plugins are made a sub-section of the erasure code profile
section. The k and m parameters are removed from erasure code profile
documentation. They were added for simplicity in the first version
because there was only one plugin. But they should really be in the
plugin documentation.

Signed-off-by: Loic Dachary <loic-201408@dachary.org>

diff --git a/doc/rados/operations/erasure-code-profile.rst b/doc/rados/operations/erasure-code-profile.rst
index b8630346f0b29acf0b652ad9faf86371dc1647b8..fdc6e57e9755708263d84dc55959a1882dee4292 100644 (file)
--- a/doc/rados/operations/erasure-code-profile.rst
+++ b/doc/rados/operations/erasure-code-profile.rst
@@ -21,14 +21,21 @@ same size as the data chunk, i.e. 1MB). The raw space overhead is only
 40% and the object will not be lost even if four OSDs break at the
 same time.
 
+.. _list of available plugins:
+
+.. toctree::
+       :maxdepth: 1
+
+       erasure-code-jerasure
+       erasure-code-isa
+       erasure-code-lrc
+
 osd erasure-code-profile set
 ============================
 
 To create a new erasure code profile::
 
        ceph osd erasure-code-profile set {name} \
-             [{k=data-chunks}] \
-             [{m=coding-chunks}] \
              [{directory=directory}] \
              [{plugin=plugin}] \
              [{key=value} ...] \
@@ -36,25 +43,6 @@ To create a new erasure code profile::
 
 Where:
 
-``{k=data-chunks}``
-
-:Description: Each object is split in **data-chunks** parts,
-              each stored on a different OSD.
-
-:Type: Integer
-:Required: No. 
-:Default: 2
-
-``{m=coding-chunks}``
-
-:Description: Compute **coding chunks** for each object and store them
-              on different OSDs. The number of coding chunks is also
-              the number of OSDs that can be down without losing data.
-
-:Type: Integer
-:Required: No. 
-:Default: 1
-
 ``{directory=directory}``
 
 :Description: Set the **directory** name from which the erasure code
@@ -67,7 +55,8 @@ Where:
 ``{plugin=plugin}``
 
 :Description: Use the erasure code **plugin** to compute coding chunks
-              and recover missing chunks.
+              and recover missing chunks. See the `list of available
+              plugins`_ for more information.
 
 :Type: String
 :Required: No. 

diff --git a/doc/rados/operations/index.rst b/doc/rados/operations/index.rst
index bfade46c1f924c4383bba569afcccb00a5d9b1f0..609cc4a92c39cec59f9488201b15a2066d65208b 100644 (file)
--- a/doc/rados/operations/index.rst
+++ b/doc/rados/operations/index.rst
@@ -33,7 +33,6 @@ CRUSH algorithm.
        data-placement
        pools
        erasure-code-profile
-       erasure-code-lrc
        cache-tiering
        placement-groups
        crush-map

diff --git a/doc/rados/operations/pools.rst b/doc/rados/operations/pools.rst
index 5fb740ef16a89be82b099e0c287aa2e584bbc8b1..522bdd0a9db6555cfd4c3b7aa5b61113cf8b6ebc 100644 (file)
--- a/doc/rados/operations/pools.rst
+++ b/doc/rados/operations/pools.rst
@@ -123,7 +123,9 @@ Where:
 
 ``[erasure-code-profile=profile]``
 
-:Description: For **erasure** pools only. Use the erasure code **profile**. It 
+.. _erasure code profile: ../erasure-code-profile
+
+:Description: For **erasure** pools only. Use the `erasure code profile`_. It
               must be an existing profile as defined by 
               **osd erasure-code-profile set**.