Commit Graph

15 Commits

Author SHA1 Message Date
Fabio Fantoni
3ee23096ad doc:it_IT: fix some typos
Fix of some typos spotted reading documentation in italian and latest
changes for 6.4

Signed-off-by: Fabio Fantoni <fantonifabio@tiscali.it>
Reviewed-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20230425110158.9755-1-fantonifabio@tiscali.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-04-26 12:42:08 -06:00
Federico Vaga
c1f8e848fc doc:it_IT: translation alignment
Major update for maintainer-pgp-guide

commit e441273947 ("Documentation: raise minimum supported version of binutils to 2.25")
commit 67fe6792a7 ("Documentation: stable: Document alternative for referring upstream commit hash")
commit 8763a30bc1 ("docs: deprecated.rst: Add note about DECLARE_FLEX_ARRAY() usage
commit 2f993509a9 ("docs: process/5.Posting.rst: clarify use of Reported-by: tag")
commit a31323bef2 ("timers: Update the documentation to reflect on the new timer_shutdown() API")

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20230319134624.21327-1-federico.vaga@vaga.pv.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-03-23 11:27:00 -06:00
Alexander Sverdlin
379af13b31 docs: locking: Discourage from calling disable_irq() in atomic
Correct the example in the documentation so that disable_irq() is not being
called in atomic context.

disable_irq() calls sleeping synchronize_irq(), it's not allowed to call
them in atomic context.

Signed-off-by: Alexander Sverdlin <alexander.sverdlin@siemens.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Manfred Spraul <manfred@colorfullife.com>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/lkml/87k02wbs2n.ffs@tglx/
Link: https://lore.kernel.org/r/20221212163715.830315-1-alexander.sverdlin@siemens.com
2023-01-11 19:45:26 +01:00
Thomas Gleixner
87bdd932e8 Documentation: Replace del_timer/del_timer_sync()
Adjust to the new preferred function names.

Suggested-by: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
Reviewed-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Link: https://lore.kernel.org/r/20221123201625.075320635@linutronix.de
2022-11-24 15:09:11 +01:00
Thomas Gleixner
b0b0aa5d85 Documentation: Remove bogus claim about del_timer_sync()
del_timer_sync() does not return the number of times it tried to delete the
timer which rearms itself. It's clearly documented:

 The function returns whether it has deactivated a pending timer or not.

This part of the documentation is from 2003 where del_timer_sync() really
returned the number of deletion attempts for unknown reasons. The code
was rewritten in 2005, but the documentation was not updated.

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Jacob Keller <jacob.e.keller@intel.com>
Reviewed-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Link: https://lore.kernel.org/r/20221123201624.452282769@linutronix.de
2022-11-24 15:09:10 +01: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
André Almeida
bc67f1c454 docs: futex: Fix kernel-doc references
Since the futex code was restructured, there's no futex.c file anymore
and the implementation is split in various files. Point kernel-doc
references to the new files.

Signed-off-by: André Almeida <andrealmeid@collabora.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Link: https://lkml.kernel.org/r/20211012135549.14451-1-andrealmeid@collabora.com
2021-10-19 17:27:05 +02:00
Changbin Du
fe450eeb4e Documentation: in_irq() cleanup
Replace the obsolete and ambiguos macro in_irq() with new
macro in_hardirq().

Signed-off-by: Changbin Du <changbin.du@gmail.com>

Link: https://lore.kernel.org/r/20210814014831.53083-1-changbin.du@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-08-24 13:28:23 -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
Mauro Carvalho Chehab
71a8156e94 docs: it_IT: fix namespace collisions at locking.rst
The C domain functions there collide with the English ones,
due to namespace collision, generating lots of warnings with
Sphinx 3.x:

	./include/linux/mutex.h:121: WARNING: Duplicate C declaration, also defined in 'translations/it_IT/kernel-hacking/locking'.
	Declaration is 'mutex_init'.
	./include/linux/mutex.h:152: WARNING: Duplicate C declaration, also defined in 'translations/it_IT/kernel-hacking/locking'.
	Declaration is 'mutex_is_locked'.
	./include/linux/mutex.h:226: WARNING: Duplicate C declaration, also defined in 'translations/it_IT/kernel-hacking/locking'.
	Declaration is 'mutex_trylock_recursive'.
	./kernel/locking/mutex.c:281: WARNING: Duplicate C declaration, also defined in 'translations/it_IT/kernel-hacking/locking'.
	Declaration is 'mutex_lock'.
	...

Add a namespace tag there, in order to prevent that.

Acked-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-10-15 07:49:40 +02: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
Mauro Carvalho Chehab
387b14684f docs: locking: convert docs to ReST and rename to *.rst
Convert the locking documents to ReST and add them to the
kernel development book where it belongs.

Most of the stuff here is just to make Sphinx to properly
parse the text file, as they're already in good shape,
not requiring massive changes in order to be parsed.

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>
Acked-by: Federico Vaga <federico.vaga@vaga.pv.it>
2019-07-15 08:53:27 -03:00
Stephen Kitt
220ee02a0b docs: stop suggesting strlcpy
Since strlcpy is deprecated, the documentation shouldn't suggest using
it. This patch fixes the examples to use strscpy instead. It also uses
sizeof instead of underlying constants as far as possible, to simplify
future changes to the corresponding data structures.

Signed-off-by: Stephen Kitt <steve@sk2.org>
Acked-by: Kees Cook <keescook@chromium.org>
Acked-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-20 14:08:49 -06:00
Federico Vaga
34523ec2f4 doc:it_IT: fix locking.rst section title
This title was still in English. I just translated it

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-11-20 09:11:23 -07:00
Federico Vaga
1497624fff doc:it_IT: translation for kernel-hacking
This patch includes the kernel-hacking translation in Italian (both
hacking.rst and locking.rst).

It adds also the anchors for the english kernel-hacking documents.

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-07-26 16:21:09 -06:00