mbox series

[0/6] docs: kbuild makefile documentation cleanups

Message ID 20230117095946.2042832-1-jani.nikula@intel.com (mailing list archive)
Headers show
Series docs: kbuild makefile documentation cleanups | expand

Message

Jani Nikula Jan. 17, 2023, 9:59 a.m. UTC 
I usually shy away from making rst updates, but the makefiles.rst file
always bugs me when I look at it, so here goes. Even I usually look at
the rst file in the editor instead of html in the browser, but the
editor knows about rst...

This is based on the kbuild branch of linux-kbuild.git, and there's a
MAINTAINERS update too to fix the branch name. ;)

BR,
Jani.


Jani Nikula (6):
  MAINTAINERS: fix kbuild repo branch
  docs/kbuild/makefiles: fix header underline
  docs/kbuild/makefiles: throw out the local table of contents
  docs/kbuild/makefiles: drop section numbering, use references
  docs/kbuild/makefiles: clean up indentation and whitespace
  docs/kbuild/makefiles: unify quoting

 Documentation/kbuild/makefiles.rst | 2148 ++++++++++++++--------------
 MAINTAINERS                        |    2 +-
 2 files changed, 1060 insertions(+), 1090 deletions(-)

Comments

Masahiro Yamada Jan. 18, 2023, 7:59 a.m. UTC | #1 
On Tue, Jan 17, 2023 at 7:00 PM Jani Nikula <jani.nikula@intel.com> wrote:
>
> I usually shy away from making rst updates, but the makefiles.rst file
> always bugs me when I look at it, so here goes. Even I usually look at
> the rst file in the editor instead of html in the browser, but the
> editor knows about rst...
>
> This is based on the kbuild branch of linux-kbuild.git, and there's a
> MAINTAINERS update too to fix the branch name. ;)
>
> BR,
> Jani.


All applied to linux-kbuild. Thanks.


>
> Jani Nikula (6):
>   MAINTAINERS: fix kbuild repo branch
>   docs/kbuild/makefiles: fix header underline
>   docs/kbuild/makefiles: throw out the local table of contents
>   docs/kbuild/makefiles: drop section numbering, use references
>   docs/kbuild/makefiles: clean up indentation and whitespace
>   docs/kbuild/makefiles: unify quoting
>
>  Documentation/kbuild/makefiles.rst | 2148 ++++++++++++++--------------
>  MAINTAINERS                        |    2 +-
>  2 files changed, 1060 insertions(+), 1090 deletions(-)
>
> --
> 2.34.1
>