Re: [PATCH RESEND] Documentation: add missing page title for kernel-doc.rst and sphinx.rst

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

 



On 26/03/22 02.29, Jonathan Corbet wrote:
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 79aaa55d6bcf2b..de47b20c806acf 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -1,3 +1,7 @@
+==========================
+kernel-doc Comments Format
+==========================
+
  Writing kernel-doc comments
  ===========================

Honestly, I think this is better fixed just by promoting the existing
heading up a level.  It describes the file nicely, and we don't need two
headers there.


OK.

diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index bb36f18ae9ac3e..140507de5a85e0 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -1,5 +1,9 @@
  .. _sphinxdoc:
+=============
+Sphinx Primer
+=============
+
  Introduction
  ============

Here, perhaps, replace "Introduction" with "Using Sphinx for kernel
documentation" or some such and make that the document title?


I agree with your document title suggestion.

--
An old man doll... just what I always wanted! - Clara



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux