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
Re: [PATCH 10/10] docs: fix broken documentation links
On Monday, May 20, 2019 4:47:39 PM CEST Mauro Carvalho Chehab wrote: > Mostly due to x86 and acpi conversion, several documentation > links are still pointing to the old file. Fix them. > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/acpi/dsd/leds.txt | 2 +- > Documentation/admin-guide/kernel-parameters.rst | 6 +++--- > Documentation/admin-guide/kernel-parameters.txt | 16 > Documentation/admin-guide/ras.rst| 2 +- > .../devicetree/bindings/net/fsl-enetc.txt| 7 +++ > .../bindings/pci/amlogic,meson-pcie.txt | 2 +- > .../bindings/regulator/qcom,rpmh-regulator.txt | 2 +- > Documentation/devicetree/booting-without-of.txt | 2 +- > Documentation/driver-api/gpio/board.rst | 2 +- > Documentation/driver-api/gpio/consumer.rst | 2 +- > .../firmware-guide/acpi/enumeration.rst | 2 +- > .../firmware-guide/acpi/method-tracing.rst | 2 +- > Documentation/i2c/instantiating-devices | 2 +- > Documentation/sysctl/kernel.txt | 4 ++-- > .../translations/it_IT/process/4.Coding.rst | 2 +- > .../translations/it_IT/process/howto.rst | 2 +- > .../it_IT/process/stable-kernel-rules.rst| 4 ++-- > .../translations/zh_CN/process/4.Coding.rst | 2 +- > Documentation/x86/x86_64/5level-paging.rst | 2 +- > Documentation/x86/x86_64/boot-options.rst| 4 ++-- > .../x86/x86_64/fake-numa-for-cpusets.rst | 2 +- > MAINTAINERS | 6 +++--- > arch/arm/Kconfig | 2 +- > arch/arm64/kernel/kexec_image.c | 2 +- > arch/powerpc/Kconfig | 2 +- > arch/x86/Kconfig | 16 > arch/x86/Kconfig.debug | 2 +- > arch/x86/boot/header.S | 2 +- > arch/x86/entry/entry_64.S| 2 +- > arch/x86/include/asm/bootparam_utils.h | 2 +- > arch/x86/include/asm/page_64_types.h | 2 +- > arch/x86/include/asm/pgtable_64_types.h | 2 +- > arch/x86/kernel/cpu/microcode/amd.c | 2 +- > arch/x86/kernel/kexec-bzimage64.c| 2 +- > arch/x86/kernel/pci-dma.c| 2 +- > arch/x86/mm/tlb.c| 2 +- > arch/x86/platform/pvh/enlighten.c| 2 +- > drivers/acpi/Kconfig | 10 +- > drivers/net/ethernet/faraday/ftgmac100.c | 2 +- > .../fieldbus/Documentation/fieldbus_dev.txt | 4 ++-- > drivers/vhost/vhost.c| 2 +- > include/acpi/acpi_drivers.h | 2 +- > include/linux/fs_context.h | 2 +- > include/linux/lsm_hooks.h| 2 +- > mm/Kconfig | 2 +- > security/Kconfig | 2 +- > tools/include/linux/err.h| 2 +- > tools/objtool/Documentation/stack-validation.txt | 4 ++-- > tools/testing/selftests/x86/protection_keys.c| 2 +- > 49 files changed, 78 insertions(+), 79 deletions(-) > > diff --git a/Documentation/acpi/dsd/leds.txt > b/Documentation/acpi/dsd/leds.txt index 81a63af42ed2..cc58b1a574c5 100644 > --- a/Documentation/acpi/dsd/leds.txt > +++ b/Documentation/acpi/dsd/leds.txt > @@ -96,4 +96,4 @@ where > > http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-da > ta-extension-UUID-v1.1.pdf>, referenced 2019-02-21. > > -[7] Documentation/acpi/dsd/data-node-reference.txt > +[7] Documentation/firmware-guide/acpi/dsd/data-node-references.rst > diff --git a/Documentation/admin-guide/kernel-parameters.rst > b/Documentation/admin-guide/kernel-parameters.rst index > 0124980dca2d..8d3273e32eb1 100644 > --- a/Documentation/admin-guide/kernel-parameters.rst > +++ b/Documentation/admin-guide/kernel-parameters.rst > @@ -167,7 +167,7 @@ parameter is applicable:: > X86-32 X86-32, aka i386 architecture is enabled. > X86-64 X86-64 architecture is enabled. > More X86-64 boot options can be found in > - Documentation/x86/x86_64/boot-options.txt . > + Documentation/x86/x86_64/boot-options.rst. > X86 Either 32-bit or 64-bit x86 (same as X86-32+X86-64) > X86_UV SGI UV support is enabled. > XEN Xen support is enabled > @@ -181,10 +181,10 @@ In addition, the following text indicates that the > option:: Parameters denoted with BOOT are actually interpreted by the boot > loader, and have no meaning to the kernel directly. > Do not modify the syntax of boot loader parameters without extreme > -need or coordination with . > +need or coordination with . > > There are also arch-specific kernel-parameters not documented here. > -See for example . > +See
