[PATCH] docs: admin-guide: Extend short title underline in sysctl

2019-10-14 Thread Adam Zerella
Title underlines should extend the full length of a title, Sphinx is currently displaying the following warning when building the htmldocs: sysctl/kernel.rst:397: WARNING: Title underline too short. hung_task_interval_warnings: === Signed-off-by: Adam Zerella --- Documentation

Re: [PATCH] doc: move namespaces.rst out of kbuild directory

2019-10-06 Thread Adam Zerella
On Mon, Oct 07, 2019 at 01:36:11PM +0900, Masahiro Yamada wrote: > I did not notice this document was added to Documentation/kbuild/, > and I do not understand how it is related to the build system. > > Kick it out of the kbuild directory. Should we delete the file entirely or does it belong some

[PATCH] Documentation: kbuild: Add document about namespaces

2019-10-06 Thread Adam Zerella
Sphinx outputs the following build warning: Documentation/kbuild/namespaces.rst: WARNING: document isn't included in any toctree Assuming this document is intended to be referenced within the documentation it should be inside the toctree. Signed-off-by: Adam Zerella --- Documentation/k

[PATCH] hwmon: docs: Extend inspur-ipsps1 title underline

2019-10-06 Thread Adam Zerella
Sphinx is generating a build warning as the title underline of this file is too short. Signed-off-by: Adam Zerella --- Documentation/hwmon/inspur-ipsps1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/hwmon/inspur-ipsps1.rst b/Documentation/hwmon/inspur

Re: [PATCH] docs: arm64: Fix indentation and doc formatting

2019-10-01 Thread Adam Zerella
On Mon, Sep 30, 2019 at 01:28:23PM +0100, Will Deacon wrote: > On Sat, Sep 28, 2019 at 10:58:19PM +1000, Adam Zerella wrote: > > Sphinx generates the following warnings for the arm64 doc > > pages: > > > > Documentation/arm64/memory.rst:158: WARNING: Unexpected ind

Re: [PATCH] docs: networking: Add title caret and missing doc

2019-10-01 Thread Adam Zerella
On Mon, Sep 30, 2019 at 11:37:54AM -0700, Jakub Kicinski wrote: > On Sat, 28 Sep 2019 22:39:17 +1000, Adam Zerella wrote: > > Resolving a couple of Sphinx documentation warnings > > that are generated in the networking section. > > > > - WARNING: document is

[PATCH v2] docs: networking: Add title caret and missing doc

2019-10-01 Thread Adam Zerella
Resolving a couple of Sphinx documentation warnings that are generated in the networking section. - WARNING: document isn't included in any toctree - WARNING: Title underline too short. Signed-off-by: Adam Zerella --- v2: Moved 'netronome/nfp' into alphabetical order ---

[PATCH] docs: arm64: Fix indentation and doc formatting

2019-09-28 Thread Adam Zerella
-off-by: Adam Zerella --- Documentation/arm64/memory.rst | 9 +++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/Documentation/arm64/memory.rst b/Documentation/arm64/memory.rst index b040909e45f8..f7db6a3898c5 100644 --- a/Documentation/arm64/memory.rst +++ b/Documentation

[PATCH] docs: networking: Add title caret and missing doc

2019-09-28 Thread Adam Zerella
Resolving a couple of Sphinx documentation warnings that are generated in the networking section. - WARNING: document isn't included in any toctree - WARNING: Title underline too short. Signed-off-by: Adam Zerella --- Documentation/networking/device_drivers/index.rst | 1 + Document

[PATCH] docs: hwmon: Include 'inspur-ipsps1.rst' into docs

2019-09-25 Thread Adam Zerella
When generating documentation output Sphinx outputs a warning for not including the page 'inspur-ipsps1.rst' in 'index.rst'. Assuming this documentation is useful it should be included in the index. Signed-off-by: Adam Zerella --- Documentation/hwmon/index.rst | 1

[PATCH] docs: hwmon: Suppress Sphinx warning

2019-09-15 Thread Adam Zerella
When generating documentation output Sphinx outputs a warning for not including the page 'inspur-ipsps1.rst' in 'index.rst'. Assuming this documentation is useful it should be included in the index Signed-off-by: Adam Zerella --- Documentation/hwmon/index.rst | 1 + 1 file

[PATCH v2] docs: perf: Add imx-ddr to documentation index

2019-09-15 Thread Adam Zerella
Sphinx is currently outputting a warning where the file 'imx-ddr.rst' is not included in the documentation index. Additionally, the code highlighting and doc formatting can be slightly improved. Signed-off-by: Adam Zerella --- v2: Supress additional indentation warning --- Documenta

[PATCH] docs: perf: Add imx-ddr to documentation index

2019-09-14 Thread Adam Zerella
Sphinx is currently outputting a warning where the file 'imx-ddr.rst' is not included in the documentation index. Additionally, the code highlighting and doc formatting can be slightly improved. Signed-off-by: Adam Zerella --- Documentation/admin-guide/perf/imx-dd