[PATCH] doc: Sphinx's option ':noindex:' have been rename into ':noindexentry:'

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



and instead of keeping the old name for compatibility, no it's rejected.
But well, purity of language is surely much more important than compatibility.
*long deep sigh*

So, use the new name (but it will for sure create problems when using
an older version of Sphinx).

Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@xxxxxxxxx>
---
 Documentation/doc-guide.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/doc-guide.rst b/Documentation/doc-guide.rst
index 29f39aab360a..fb4cb32293a8 100644
--- a/Documentation/doc-guide.rst
+++ b/Documentation/doc-guide.rst
@@ -138,7 +138,7 @@ For example, a doc-block like::
 will be displayed like this:
 
 .. c:function:: int inc(int val)
-	:noindex:
+	:noindexentry:
 
 	:param val: the value to increment
 	:return: the incremented value
-- 
2.29.2




[Index of Archives]     [Newbies FAQ]     [LKML]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Trinity Fuzzer Tool]

  Powered by Linux