Re: [PATCH v3 14/33] docs: kbuild: convert docs to ReST and rename to *.rst
In data Sunday, June 9, 2019 4:27:04 AM CEST, Mauro Carvalho Chehab ha
scritto:
> The kbuild documentation clearly shows that the documents
> there are written at different times: some use markdown,
> some use their own peculiar logic to split sections.
>
> Convert everything to ReST without affecting too much
> the author's style and avoiding adding uneeded markups.
>
> The conversion is actually:
> - add blank lines and identation in order to identify paragraphs;
> - fix tables markups;
> - add some lists markups;
> - mark literal blocks;
> - adjust title markups.
>
> At its new index.rst, let's add a :orphan: while this is not linked to
> the main index.rst file, in order to avoid build warnings.
>
> Signed-off-by: Mauro Carvalho Chehab
> ---
> Documentation/admin-guide/README.rst | 2 +-
> ...eaders_install.txt => headers_install.rst} | 5 +-
> Documentation/kbuild/index.rst| 27 +
> Documentation/kbuild/issues.rst | 11 +
> .../kbuild/{kbuild.txt => kbuild.rst} | 119 ++--
> ...nfig-language.txt => kconfig-language.rst} | 232
> ...anguage.txt => kconfig-macro-language.rst} | 37 +-
> .../kbuild/{kconfig.txt => kconfig.rst} | 136 +++--
> .../kbuild/{makefiles.txt => makefiles.rst} | 530 +++---
> .../kbuild/{modules.txt => modules.rst} | 168 +++---
> Documentation/kernel-hacking/hacking.rst | 4 +-
> Documentation/process/coding-style.rst| 2 +-
> Documentation/process/submit-checklist.rst| 2 +-
> .../it_IT/kernel-hacking/hacking.rst | 4 +-
> .../it_IT/process/coding-style.rst| 2 +-
> .../it_IT/process/submit-checklist.rst| 2 +-
Limited to translations/it_IT
Acked-by: Federico Vaga
> .../zh_CN/process/coding-style.rst| 2 +-
> .../zh_CN/process/submit-checklist.rst| 2 +-
> Kconfig | 2 +-
> arch/arc/plat-eznps/Kconfig | 2 +-
> arch/c6x/Kconfig | 2 +-
> arch/microblaze/Kconfig.debug | 2 +-
> arch/microblaze/Kconfig.platform | 2 +-
> arch/nds32/Kconfig| 2 +-
> arch/openrisc/Kconfig | 2 +-
> arch/powerpc/sysdev/Kconfig | 2 +-
> arch/riscv/Kconfig| 2 +-
> drivers/auxdisplay/Kconfig| 2 +-
> drivers/firmware/Kconfig | 2 +-
> drivers/mtd/devices/Kconfig | 2 +-
> drivers/net/ethernet/smsc/Kconfig | 6 +-
> drivers/net/wireless/intel/iwlegacy/Kconfig | 4 +-
> drivers/net/wireless/intel/iwlwifi/Kconfig| 2 +-
> drivers/parport/Kconfig | 2 +-
> drivers/scsi/Kconfig | 4 +-
> drivers/staging/sm750fb/Kconfig | 2 +-
> drivers/usb/misc/Kconfig | 4 +-
> drivers/video/fbdev/Kconfig | 14 +-
> net/bridge/netfilter/Kconfig | 2 +-
> net/ipv4/netfilter/Kconfig| 2 +-
> net/ipv6/netfilter/Kconfig| 2 +-
> net/netfilter/Kconfig | 16 +-
> net/tipc/Kconfig | 2 +-
> scripts/Kbuild.include| 4 +-
> scripts/Makefile.host | 2 +-
> scripts/kconfig/symbol.c | 2 +-
> .../tests/err_recursive_dep/expected_stderr | 14 +-
> sound/oss/dmasound/Kconfig| 6 +-
> 48 files changed, 840 insertions(+), 561 deletions(-)
> rename Documentation/kbuild/{headers_install.txt => headers_install.rst}
> (96%) create mode 100644 Documentation/kbuild/index.rst
> create mode 100644 Documentation/kbuild/issues.rst
> rename Documentation/kbuild/{kbuild.txt => kbuild.rst} (72%)
> rename Documentation/kbuild/{kconfig-language.txt => kconfig-language.rst}
> (85%) rename Documentation/kbuild/{kconfig-macro-language.txt =>
> kconfig-macro-language.rst} (94%) rename Documentation/kbuild/{kconfig.txt
> => kconfig.rst} (80%)
> rename Documentation/kbuild/{makefiles.txt => makefiles.rst} (83%)
> rename Documentation/kbuild/{modules.txt => modules.rst} (84%)
___
devel mailing list
de...@linuxdriverproject.org
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel
Re: [PATCH v3 14/33] docs: kbuild: convert docs to ReST and rename to *.rst
In data Sunday, June 9, 2019 4:27:04 AM CEST, Mauro Carvalho Chehab ha
scritto:
> The kbuild documentation clearly shows that the documents
> there are written at different times: some use markdown,
> some use their own peculiar logic to split sections.
>
> Convert everything to ReST without affecting too much
> the author's style and avoiding adding uneeded markups.
>
> The conversion is actually:
> - add blank lines and identation in order to identify paragraphs;
> - fix tables markups;
> - add some lists markups;
> - mark literal blocks;
> - adjust title markups.
>
> At its new index.rst, let's add a :orphan: while this is not linked to
> the main index.rst file, in order to avoid build warnings.
>
> Signed-off-by: Mauro Carvalho Chehab
> ---
> Documentation/admin-guide/README.rst | 2 +-
> ...eaders_install.txt => headers_install.rst} | 5 +-
> Documentation/kbuild/index.rst| 27 +
> Documentation/kbuild/issues.rst | 11 +
> .../kbuild/{kbuild.txt => kbuild.rst} | 119 ++--
> ...nfig-language.txt => kconfig-language.rst} | 232
> ...anguage.txt => kconfig-macro-language.rst} | 37 +-
> .../kbuild/{kconfig.txt => kconfig.rst} | 136 +++--
> .../kbuild/{makefiles.txt => makefiles.rst} | 530 +++---
> .../kbuild/{modules.txt => modules.rst} | 168 +++---
> Documentation/kernel-hacking/hacking.rst | 4 +-
> Documentation/process/coding-style.rst| 2 +-
> Documentation/process/submit-checklist.rst| 2 +-
> .../it_IT/kernel-hacking/hacking.rst | 4 +-
> .../it_IT/process/coding-style.rst| 2 +-
> .../it_IT/process/submit-checklist.rst| 2 +-
Limited to translations/it_IT
Acked-by: Federico Vaga
> .../zh_CN/process/coding-style.rst| 2 +-
> .../zh_CN/process/submit-checklist.rst| 2 +-
> Kconfig | 2 +-
> arch/arc/plat-eznps/Kconfig | 2 +-
> arch/c6x/Kconfig | 2 +-
> arch/microblaze/Kconfig.debug | 2 +-
> arch/microblaze/Kconfig.platform | 2 +-
> arch/nds32/Kconfig| 2 +-
> arch/openrisc/Kconfig | 2 +-
> arch/powerpc/sysdev/Kconfig | 2 +-
> arch/riscv/Kconfig| 2 +-
> drivers/auxdisplay/Kconfig| 2 +-
> drivers/firmware/Kconfig | 2 +-
> drivers/mtd/devices/Kconfig | 2 +-
> drivers/net/ethernet/smsc/Kconfig | 6 +-
> drivers/net/wireless/intel/iwlegacy/Kconfig | 4 +-
> drivers/net/wireless/intel/iwlwifi/Kconfig| 2 +-
> drivers/parport/Kconfig | 2 +-
> drivers/scsi/Kconfig | 4 +-
> drivers/staging/sm750fb/Kconfig | 2 +-
> drivers/usb/misc/Kconfig | 4 +-
> drivers/video/fbdev/Kconfig | 14 +-
> net/bridge/netfilter/Kconfig | 2 +-
> net/ipv4/netfilter/Kconfig| 2 +-
> net/ipv6/netfilter/Kconfig| 2 +-
> net/netfilter/Kconfig | 16 +-
> net/tipc/Kconfig | 2 +-
> scripts/Kbuild.include| 4 +-
> scripts/Makefile.host | 2 +-
> scripts/kconfig/symbol.c | 2 +-
> .../tests/err_recursive_dep/expected_stderr | 14 +-
> sound/oss/dmasound/Kconfig| 6 +-
> 48 files changed, 840 insertions(+), 561 deletions(-)
> rename Documentation/kbuild/{headers_install.txt => headers_install.rst}
> (96%) create mode 100644 Documentation/kbuild/index.rst
> create mode 100644 Documentation/kbuild/issues.rst
> rename Documentation/kbuild/{kbuild.txt => kbuild.rst} (72%)
> rename Documentation/kbuild/{kconfig-language.txt => kconfig-language.rst}
> (85%) rename Documentation/kbuild/{kconfig-macro-language.txt =>
> kconfig-macro-language.rst} (94%) rename Documentation/kbuild/{kconfig.txt
> => kconfig.rst} (80%)
> rename Documentation/kbuild/{makefiles.txt => makefiles.rst} (83%)
> rename Documentation/kbuild/{modules.txt => modules.rst} (84%)
___
devel mailing list
de...@linuxdriverproject.org
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel
