Commit Graph

16 Commits

Author SHA1 Message Date
Thorsten Blum 932be49b71 Documentation: coding-style: Fix indentation in code-blocks
- Remove spaces in C code-blocks to align error labels consistently
- Replace tab characters with spaces in emacs-lisp code blocks

Signed-off-by: Thorsten Blum <thorsten.blum@toblux.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240202231316.7606-1-thorsten.blum@toblux.com
2024-02-05 10:15:31 -07:00
Federico Vaga 1d6f52a7c8 doc:it_IT: translation alignment
Italian translation updated following these changes:

commit 901578a459 ("docs: recommend using Link: whenever using Reported-by:")"
commit 775a445d9a ("coding-style: fix title of Greg K-H's talk")
commit 1d2ed9234c ("Documentation: process: Document suitability of Proton Mail for kernel development")
commit 9d0f5cd167 ("docs: promote the title of process/index.rst")
commit d4563201f3 ("Documentation: simplify and clarify DCO contribution example language")
commit e7b4311ebc ("Replace HTTP links with HTTPS ones: Documentation/process")
commit 0b02076f99 ("docs: programming-language: add Rust programming language section")
commit 38484a1d0c ("docs: programming-language: remove mention of the Intel compiler")
commit b8885e2615 ("Documentation: front page: use recommended heading adornments")

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20230326130213.28755-1-federico.vaga@vaga.pv.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-03-29 10:47:38 -06:00
Federico Vaga da1d9caf95 doc:it_IT: align Italian documentation
Translation for the following patches

commit df05c0e949 ("Documentation: Raise the minimum supported version of LLVM to 11.0.0")
commit 333b11e541 ("Documentation: Add minimum pahole version")
commit 6d6a8d6a4e ("docs: Update Sphinx requirements")
commit 76ae847497 ("Documentation: raise minimum supported version of GCC to 5.1")
commit 59c6a716b1 ("Documentation/process/maintainer-pgp-guide: Replace broken link to PGP path finder")
commit 85eafc63d0 ("docs: update file link location")
commit 869f496e1a ("docs: process: submitting-patches: Clarify the Reported-by usage")
commit 6c5ccd24ff ("Remove mentions of the Trivial Patch Monkey")
commit aa9b5e0df2 ("Documentation/process: fix self reference")
commit b96ff02ab2 ("Documentation/process: fix a cross reference")
commit 1f57bd42b7 ("docs: submitting-patches: make section about the Link: tag more explicit")
commit a9d85efb25 ("docs: use the lore redirector everywhere")
commit 31c9d7c829 ("Documentation/process: Add tip tree handbook")
commit 604370e106 ("Documentation/process: Add maintainer handbooks section")
commit bf33a9d42d ("docs: 5.Posting.rst: describe Fixes: and Link: tags")
commit c04639a7d2 ("coding-style.rst: trivial: fix location of driver model macros")
commit d5b421fe02 ("docs: Explain the desired position of function attributes")
commit 3577cdb23b ("docs: deprecated.rst: Clarify open-coded arithmetic with literals")
commit db67eb748e ("docs: discourage use of list tables")
commit 0e805b1186 ("docs: address some text issues with css/theme support")
commit 135707d376 ("docs: allow to pass extra DOCS_CSS themes via make")
commit fe450eeb4e ("Documentation: in_irq() cleanup")
commit 10855b45a4 ("docs: fix typo in Documentation/kernel-hacking/locking.rst")
commit bc67f1c454 ("docs: futex: Fix kernel-doc references")
commit abf36fe0be ("docs: kernel-hacking: Remove inappropriate text")
commit f35cf1a59e ("Documentation: kernel-hacking: minor edits for style")
commit f35cf1a59e ("Documentation: kernel-hacking: minor edits for style")
commit 980c3799c5 ("Documentation: kernel-doc: Promote two chapter headings to page title")
commit e1be43d9b5 ("overflow: Implement size_t saturating arithmetic helpers")
commit 615f3eea0d ("Documentation: add note block surrounding security patch note")
commit 587d39b260 ("Documentation: add link to stable release candidate tree")
commit 555d44932c ("Documentation: update stable tree link")
commit 88d99e8701 ("Documentation: update stable review cycle documentation")
commit 0c603a5c70 ("Documentation/process: mention patch changelog in review process")
commit 6d5aa418b3 ("docs: submitting-patches: Fix crossref to 'The canonical patch format'")
commit f1a693994b ("Documentation/process: use scripts/get_maintainer.pl on patches")
commit 69ef0920bd ("Docs: Add cpio requirement to changes.rst")
commit 5a5866c28b ("Docs: Replace version by 'current' in changes.rst")
commit 9b5a7f4a2a ("x86/configs: Add x86 debugging Kconfig fragment plus docs")
commit f1a693994b ("Documentation/process: use scripts/get_maintainer.pl on patches")
commit e8c07082a8 ("Kbuild: move to -std=gnu11")

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20220702210820.13118-1-federico.vaga@vaga.pv.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-28 09:34:27 -06:00
Wei Ming Chen cc3496bf86 docs: Use fallthrough pseudo-keyword
Replace /* fall through */ comment with fallthrough, make
it align with original process/coding-style.rst

Signed-off-by: Wei Ming Chen <jj251510319013@gmail.com>
Link: https://lore.kernel.org/r/20210515155142.2490-1-jj251510319013@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-05-20 14:06:52 -06:00
Federico Vaga 511aaf2b32 doc:it_IT: align Italian documentation
Translation for the following patches

commit 7dfbea4c46 ("scripts: remove namespace.pl")
commit 1a63f9cce7 ("docs: Remove make headers_check from checklist")
commit 1e013ff7cb ("docs: Document cross-referencing using relative path")
commit 0be1511f51 ("Documentation: doc-guide: fixes to sphinx.rst")
commit 9113584012 ("kernel-doc: Fix example in Nested structs/unions")
commit 875f82cb37 ("Documentation/submitting-patches: Extend commit message layout description")
commit 78f101a1b2 ("Documentation/submitting-patches: Add blurb about backtraces in commit messages")
commit f0ea149eee ("docs: submitting-patches: Emphasise the requirement to Cc: stable when using Fixes: tag")
commit 05a5f51ca5 ("Documentation: Replace lkml.org links with lore")
commit 9bf19b78a2 ("Documentation/submitting-patches: Document the SoB chain")
commit b7592e5b82 ("docs: Remove the Microsoft rhetoric")
commit 26606ce072 ("coding-style.rst: Avoid comma statements")
commit dd58e64974 ("docs: Make syscalls' helpers naming consistent")
commit 460cd17e9f ("net: switch to the kernel.org patchwork instance")
commit 163ba35ff3 ("doc: use KCFLAGS instead of EXTRA_CFLAGS to pass flags from command line")
commit 0ef597c3ac ("docs: remove mention of ENABLE_MUST_CHECK")
commit f8408264c7 ("drivers: Remove CONFIG_OPROFILE support")
commit 0653c358d2 ("scsi: Drop gdth driver")
commit f8ae7bbec7 ("net: x25_asy: Delete the x25_asy driver")
commit cf6d6fc279 ("docs: process/howto.rst: make sections on bug reporting match practice")
commit da514157c4 ("docs: make reporting-bugs.rst obsolete")
commit 4f8af077a0 ("docs: Fix reST markup when linking to sections")
commit 3a4928cf5e ("Documentation: kernel-hacking: change 'current()' to 'current'")
commit c170f2eb96 ("docs: Document cross-referencing between documentation pages")

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20210409224104.30471-1-federico.vaga@vaga.pv.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-04-13 15:08:55 -06:00
Federico Vaga ac77114270 doc:it_IT: align Italian documentation
Translation for the following patches

commit 0aa78b105f ("Documentation/changes: Raise minimum supported binutils version to 2.23")
commit 7d71788735 ("Documentation: include sign off for reverts")
commit 905705a8fd ("docs: programming-languages: refresh blurb on clang support")
commit 5ff4aa70bf ("docs: submitting-patches: use :doc: for references")
commit 030f066f67 ("docs: submitting-patches: describe preserving review/test tags")
commit 68e4cd17e2 ("docs: deprecated.rst: Add zero-length and one-element arrays")
commit 5429ef62bc ("compiler/gcc: Raise minimum GCC version for kernel builds to 4.8")
commit 5b5bbb8cc5 ("docs: process: Add an example for creating a fixes tag")
commit 858e684565 ("docs: dt: convert submitting-patches.txt to ReST format")
commit cca73e4946 ("docs: Correct the release date of 5.2 stable")
commit c170f2eb96 ("docs: Document cross-referencing between documentation pages")
commit 7c8b9e3000 ("kernel-doc: Update "cross-referencing from rST" section to use automarkup")
commit 27def953b6 ("docs: deprecated.rst: Expand str*cpy() replacement notes")
commit 17dca05023 ("docs: deprecated.rst: Update zero-length/one-element arrays section")
commit 3519c4d6e0 ("Documentation: add minimum clang/llvm version")
commit 0bddd227f3 ("Documentation: update for gcc 4.9 requirement")
commit 9f364b605f ("submitting-patches.rst: presume git will be used")
commit 4ebdf7be21 ("Documentation/maintainer: rehome sign-off process")
commit 7433ff33e8 ("Documentation/process: expand plain-text advice")
commit eb45fb2fb1 ("docs: process: Add cross-link to security-bugs")
commit bdc48fa11e ("checkpatch/coding-style: deprecate 80-column warning")
commit f67281a72b ("Documentation: process: step 2: Link to email list fixed")

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20201114083342.13935-1-federico.vaga@vaga.pv.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-11-18 13:49:21 -07:00
Lee Jones 542dbc7e58 doc:it_IT: process: coding-style.rst: Correct __maybe_unused compiler label
Flag is __maybe_unused, not __maybe_used.

Cc: Federico Vaga <federico.vaga@vaga.pv.it>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: clang-built-linux@googlegroups.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200715122328.3882187-1-lee.jones@linaro.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-07-23 14:43:38 -06:00
Federico Vaga b67aa4ef68 doc:it_IT: align Italian translation
Translation for the following patches:

commit c4f4af4094 ("docs: Add documentation for Symbol Namespaces")
commit 36bc683dde ("kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'")
commit a035d552a9 ("Makefile: Globally enable fall-through warning")
commit b9918bdcac ("Documentation/process: Add fallthrough pseudo-keyword")
commit 58ad30cf91 ("docs: fix reference to core-api/namespaces.rst")
commit fb0e0ffe7f ("Documentation: bring process docs up to date")
commit 7af51678b6 ("docs: deprecated.rst: Add BUG()-family")
commit 7929b9836e ("docs: Remove :c:func: from process/deprecated.rst")
commit 76136e028d ("docs: deprecated.rst: Clean up fall-through details")
commit d8401f504b ("docs: deprecated.rst: Add %p to the list")
commit b1735296ce ("docs: locking: Drop :c:func: throughout")
commit 6adb775599 ("docs: locking: Add 'need' to hardirq section")

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20200430222037.4480-1-federico.vaga@vaga.pv.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-05-05 09:42:26 -06:00
Pankaj Bharadiya c593642c8b treewide: Use sizeof_field() macro
Replace all the occurrences of FIELD_SIZEOF() with sizeof_field() except
at places where these are defined. Later patches will remove the unused
definition of FIELD_SIZEOF().

This patch is generated using following script:

EXCLUDE_FILES="include/linux/stddef.h|include/linux/kernel.h"

git grep -l -e "\bFIELD_SIZEOF\b" | while read file;
do

	if [[ "$file" =~ $EXCLUDE_FILES ]]; then
		continue
	fi
	sed -i  -e 's/\bFIELD_SIZEOF\b/sizeof_field/g' $file;
done

Signed-off-by: Pankaj Bharadiya <pankaj.laxminarayan.bharadiya@intel.com>
Link: https://lore.kernel.org/r/20190924105839.110713-3-pankaj.laxminarayan.bharadiya@intel.com
Co-developed-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Kees Cook <keescook@chromium.org>
Acked-by: David Miller <davem@davemloft.net> # for net
2019-12-09 10:36:44 -08:00
Mauro Carvalho Chehab cd238effef docs: kbuild: convert docs to ReST and rename to *.rst
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 <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-14 14:21:21 -06:00
Federico Vaga 165915c17d doc:it_IT: fix file references
Fix italian translation file references based on
`scripts/documentation-file-ref-check` output.

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-07 11:36:46 -06:00
Federico Vaga 678f784cd6 doc:it_IT: translation alignment
Align Italian translation after the following changes in Documentation

bba757d857 coding-style.rst: Generic alloc functions do not need OOM logging
d8e8bcc3d8 docs: doc-guide: remove the extension from .rst files

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-04-30 06:28:20 -06:00
Federico Vaga 5eadc169fc doc:it_IT: update coding-style - expectations around bool
This patch translates in Italian the content of the following patch

7967656ffb coding-style: Clarify the expectations around bool

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-02-06 17:22:35 -07:00
Federico Vaga 3d18f58621 doc:it_IT: documentation alignment
It aligns the italian translation with the latest changes:

ae67ee6c5e docs: fix Co-Developed-by docs
3fe5dbfef4 Documentation/process/coding-style.rst: don't use "extern" with function prototypes

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-01-20 18:56:51 -07:00
Bart Van Assche 2fec7b3309 Documentation/CodingStyle: Use directory-local variables for emacs settings
In emacs 23.1 support for directory-local variables was added (see also
https://lists.gnu.org/archive/html/info-gnu-emacs/2009-07/msg00000.html).
Simplify the settings in coding-style.rst by using that feature.
Additionally, do not inherit any settings from emacs' linux coding style
to minimize dependencies on the version of emacs that is being used.

I have verified with several large and nontrivial kernel source files
that the new settings format code according to what checkpatch expects.

Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Cc: Matthew Wilcox <willy@infradead.org>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Alison Chaiken <alison@she-devel.com>
Cc: Joe Perches <joe@perches.com>
Cc: Federico Vaga <federico.vaga@vaga.pv.it>
Cc: Geyslan G. Bem <geyslan@gmail.com>
Cc: Tiago Natel de Moura <tiago4orion@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-01-07 15:32:49 -07:00
Federico Vaga edba5eecfd doc:it_IT: add some process/* translations
This patch does not translate entirely the subfolder "process/"
but only part of it (to begin with).

In order to avoid broken links, I included empty documents
for those which are not yet translated.

In order to be able to refer to all documents in "process/",
I added a sphinx label to those which had not one.

Translated documents:
- howto
- 1.Intro
- clang-format
- coding-style
- kernel-driver-statement
- magic-number
- volatile-considered-harmful
- development-process

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Alessia Mantegazza <amantegazza@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-11-20 09:11:12 -07:00