iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
linux/scripts
History
Tomasz Warniełło a5cdaea525 scripts: kernel-doc: Add the basic POD sections 
The NAME section provides the doc title, while SYNOPSIS contains
the basic syntax and usage description, which will be printed
in the help document and in the error output produced on wrong script
usage.

The rationale is to give users simple and succinct enlightment,
at the same time structuring the script internally for the maintainers.

In the synopsis, Rst-only options are grouped around rst, and the rest is
arranged as in the OPTIONS subsections (yet to be translated into POD,
check at the end of the series).

The third of the basic sections, DESCRIPTION, is added separately.

Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Disliked-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/20220218181628.1411551-2-tomasz.warniello@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-02-24 10:52:45 -07:00
..
atomic
locking/atomics, kcsan: Add instrumentation for barriers
2021-12-09 16:42:27 -08:00
basic
.gitignore: prefix local generated files with a slash
2021-05-02 00:43:35 +09:00
clang-tools
gen_compile_commands: fix missing 'sys' package
2021-09-19 10:13:03 +09:00
coccinelle
drop fen.cocci
2022-01-15 12:15:35 +01:00
dtc
scripts/dtc: dtx_diff: remove broken example from help text
2022-01-17 16:26:44 -06:00
dummy-tools
kbuild: dummy-tools: adjust to stricter stackprotector check
2021-05-17 12:10:03 +09:00
gcc-plugins
ARM development for 5.16:
2021-11-02 11:33:15 -07:00
gdb
scripts/gdb: lx-dmesg: read records individually
2021-12-16 15:52:38 +01:00
genksyms
.gitignore: prefix local generated files with a slash
2021-05-02 00:43:35 +09:00
kconfig
kbuild: do not quote string values in include/config/auto.conf
2022-01-08 18:03:57 +09:00
ksymoops
…
mod
RISC-V Patches for the 5.17 Merge Window, Part 1
2022-01-19 11:38:21 +02:00
package
kbuild: Add make tarzst-pkg build option
2021-10-12 11:50:46 +09:00
selinux
scripts/selinux,selinux: update mdp to enable policy capabilities
2020-08-17 20:42:00 -04:00
tracing
scripts/tracing: fix the bug that can't parse raw_trace_func
2021-08-04 17:49:26 -04:00
.gitignore
certs: move scripts/extract-cert to certs/
2022-01-08 18:28:21 +09:00
adjust_autoksyms.sh
kbuild: redo fake deps at include/ksym/*.h
2021-09-03 08:17:21 +09:00
as-version.sh
kbuild: Switch to 'f' variants of integrated assembler flag
2021-09-03 08:17:20 +09:00
asn1_compiler.c
…
bin2c.c
…
bloat-o-meter
scripts: switch explicitly to Python 3
2021-01-22 06:34:44 +09:00
bootgraph.pl
…
bpf_doc.py
bpf: Add bpf_skc_to_unix_sock() helper
2021-10-21 15:11:06 -07:00
cc-can-link.sh
…
cc-version.sh
kbuild: collect minimum tool versions into scripts/min-tool-version.sh
2021-04-25 05:14:26 +09:00
check_extable.sh
scripts: check_extable: fix typo in user error message
2021-09-08 11:50:28 -07:00
check-sysctl-docs
docs: add a script to check sysctl docs
2020-02-25 03:35:16 -07:00
checkdeclares.pl
scripts: make some scripts executable
2021-08-10 09:13:25 +09:00
checkincludes.pl
…
checkkconfigsymbols.py
checkkconfigsymbols.py: Remove skipping of help lines in parse_kconfig_file
2021-09-19 10:13:03 +09:00
checkpatch.pl
checkpatch: improve Kconfig help test
2022-01-20 08:52:54 +02:00
checkstack.pl
scripts/checkstack.pl: fix arm sp regex
2020-05-26 00:03:16 +09:00
checksyscalls.sh
checksyscalls: Unconditionally ignore fstat{,at}64
2021-10-07 17:16:28 -07:00
checkversion.pl
scripts: checkversion: modernize linux/version.h search strings
2021-08-05 20:55:39 +09:00
cleanfile
…
cleanpatch
…
coccicheck
scripts: coccicheck: fix troubles on non-English builds
2021-05-18 11:09:59 +02:00
config
kconfig: config script: add a little user help
2021-01-04 10:38:11 +09:00
const_structs.checkpatch
const_structs.checkpatch: add frequently used ops structs
2022-01-20 08:52:54 +02:00
decode_stacktrace.sh
scripts/decode_stacktrace.sh: indicate 'auto' can be used for base path
2021-07-08 11:48:22 -07:00
decodecode
scripts/decodecode: fix faulting instruction no print when opps.file is DOS format
2021-11-06 13:30:32 -07:00
depmod.sh
depmod: handle the case of /sbin/depmod without /sbin in PATH
2021-01-01 12:26:39 -08:00
dev-needs.sh
scripts/dev-needs: Add script to list device dependencies
2020-09-04 18:19:37 +02:00
diffconfig
scripts: switch explicitly to Python 3
2021-01-22 06:34:44 +09:00
documentation-file-ref-check
scripts: documentation-file-ref-check: fix bpf selftests path
2021-10-26 09:42:29 -06:00
export_report.pl
modpost: move the namespace field in Module.symvers last
2020-03-17 08:59:03 +09:00
extract_xc3028.pl
…
extract-ikconfig
…
extract-module-sig.pl
…
extract-sys-certs.pl
…
extract-vmlinux
…
faddr2line
…
file-size.sh
…
find-unused-docs.sh
scripts/find-unused-docs: Fix massive false positives
2020-01-27 14:25:06 -07:00
gcc-goto.sh
…
gcc-ld
…
gcc-x86_32-has-stack-protector.sh
x86/stackprotector/32: Make the canary into a regular percpu variable
2021-03-08 13:19:05 +01:00
gcc-x86_64-has-stack-protector.sh
…
gen_autoksyms.sh
kbuild: do not quote string values in include/config/auto.conf
2022-01-08 18:03:57 +09:00
gen_ksymdeps.sh
kbuild: redo fake deps at include/ksym/*.h
2021-09-03 08:17:21 +09:00
generate_initcall_order.pl
init: lto: ensure initcall ordering
2021-01-14 08:21:09 -08:00
get_abi.pl
scripts: get_abi.pl: better generate regex from what fields
2021-10-05 16:23:38 +02:00
get_dvb_firmware
…
get_feat.pl
scripts: get_feat.pl: reduce table width for all features output
2020-12-04 14:34:27 -07:00
get_maintainer.pl
get_maintainer: don't remind about no git repo when --nogit is used
2022-01-20 08:52:53 +02:00
gfp-translate
…
headerdep.pl
…
headers_install.sh
Merge branch 'work.fdpic' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
2020-08-07 13:29:39 -07:00
insert-sys-cert.c
…
jobserver-exec
scripts/jobserver-exec: Fix a typo ("envirnoment")
2021-05-17 12:10:03 +09:00
kallsyms.c
kallsyms: fix nonconverging kallsyms table with lld
2021-02-05 17:53:28 +09:00
Kbuild.include
certs: simplify $(srctree)/ handling and remove config_filename macro
2022-01-08 17:46:35 +09:00
Kconfig.include
kbuild: check the minimum assembler version in Kconfig
2021-04-25 05:14:41 +09:00
kernel-doc
scripts: kernel-doc: Add the basic POD sections
2022-02-24 10:52:45 -07:00
ld-version.sh
kbuild: collect minimum tool versions into scripts/min-tool-version.sh
2021-04-25 05:14:26 +09:00
leaking_addresses.pl
leaking_addresses: Always print a trailing newline
2021-10-15 11:25:13 +02:00
Lindent
…
link-vmlinux.sh
Kbuild updates for v5.17
2022-01-19 11:15:19 +02:00
Makefile
Kbuild updates for v5.17
2022-01-19 11:15:19 +02:00
Makefile.asm-generic
kbuild: prefix $(srctree)/ to some included Makefiles
2021-03-15 19:20:48 +09:00
Makefile.build
x86: Add straight-line-speculation mitigation
2021-12-09 13:32:25 +01:00
Makefile.clang
kbuild: Add -Werror=ignored-optimization-argument to CLANG_FLAGS
2021-09-19 10:55:18 +09:00
Makefile.clean
kbuild: prefix $(srctree)/ to some included Makefiles
2021-03-15 19:20:48 +09:00
Makefile.compiler
kbuild: remove TMPO from try-run
2021-04-25 05:25:56 +09:00
Makefile.debug
kbuild: split DEBUG_CFLAGS out to scripts/Makefile.debug
2021-10-24 13:48:33 +09:00
Makefile.dtbinst
kbuild: prefix $(srctree)/ to some included Makefiles
2021-03-15 19:20:48 +09:00
Makefile.extrawarn
Makefile.extrawarn: remove -Wnested-externs warning
2020-12-08 23:30:05 +09:00
Makefile.gcc-plugins
compiler hardening updates for v5.16-rc1
2021-11-01 17:09:03 -07:00
Makefile.headersinst
kbuild: prefix $(srctree)/ to some included Makefiles
2021-03-15 19:20:48 +09:00
Makefile.host
kbuild: sort hostprogs before passing it to ifneq
2020-08-10 01:32:59 +09:00
Makefile.kasan
kasan: always respect CONFIG_KASAN_STACK
2021-09-24 16:13:35 -07:00
Makefile.kcov
kbuild: include scripts/Makefile.* only when relevant CONFIG is enabled
2020-08-10 01:32:59 +09:00
Makefile.kcsan
kcsan: Ignore GCC 11+ warnings about TSan runtime support
2021-12-09 16:42:27 -08:00
Makefile.lib
Kbuild updates for v5.17
2022-01-19 11:15:19 +02:00
Makefile.modfinal
kbuild: Unify options for BTF generation for vmlinux and modules
2021-11-01 18:09:58 -07:00
Makefile.modinst
kbuild: do not quote string values in include/config/auto.conf
2022-01-08 18:03:57 +09:00
Makefile.modpost
kbuild: Fix comment typo in scripts/Makefile.modpost
2021-09-19 10:14:19 +09:00
Makefile.package
kbuild: Add make tarzst-pkg build option
2021-10-12 11:50:46 +09:00
Makefile.ubsan
ubsan: remove CONFIG_UBSAN_OBJECT_SIZE
2022-01-20 08:52:55 +02:00
Makefile.userprogs
kbuild: add infrastructure to build userspace programs
2020-05-17 18:52:01 +09:00
makelst
…
markup_oops.pl
…
min-tool-version.sh
Documentation: Raise the minimum supported version of LLVM to 11.0.0
2021-12-02 17:24:32 +09:00
mkcompile_h
kbuild: mkcompile_h: consider timestamp if KBUILD_BUILD_TIMESTAMP is set
2021-06-17 10:01:12 +09:00
mksysmap
mksysmap: Fix the mismatch of '.L' symbols in System.map
2020-06-06 23:39:20 +09:00
mkuboot.sh
…
module.lds.S
module: combine constructors in module linker script
2021-07-19 14:51:40 +02:00
modules-check.sh
kbuild: check module name conflict for external modules as well
2021-04-25 05:22:42 +09:00
nsdeps
kbuild: replace LANG=C with LC_ALL=C
2021-05-02 00:43:35 +09:00
objdiff
…
pahole-flags.sh
Core:
2021-11-02 06:20:58 -07:00
parse-maintainers.pl
parse-maintainers: Do not sort section content by default
2020-03-26 15:08:27 -07:00
patch-kernel
…
profile2linkerlist.pl
…
prune-kernel
…
recordmcount.c
ftrace: Have recordmcount use w8 to read relp->r_info in arm64_is_fake_mcount
2021-03-02 17:27:18 -05:00
recordmcount.h
recordmcount: Correct st_shndx handling
2021-06-18 09:09:17 -04:00
recordmcount.pl
recordmcount.pl: fix typo in s390 mcount regex
2021-12-24 10:20:12 +01:00
remove-stale-files
Kbuild updates for v5.17
2022-01-19 11:15:19 +02:00
setlocalversion
kbuild: do not quote string values in include/config/auto.conf
2022-01-08 18:03:57 +09:00
show_delta
tweewide: Fix most Shebang lines
2020-12-08 23:30:04 +09:00
sign-file.c
…
sorttable.c
RISC-V Patches for the 5.17 Merge Window, Part 1
2022-01-19 11:38:21 +02:00
sorttable.h
script/sorttable: Fix some initialization problems
2022-01-18 10:17:18 -05:00
spdxcheck-test.sh
scripts/spdxcheck-test.sh: Drop python2
2021-07-21 15:59:32 +02:00
spdxcheck.py
scripts/spdxcheck.py: Strictly read license files in utf-8
2021-07-12 09:56:50 -06:00
spelling.txt
scripts/spelling.txt: add "oveflow"
2022-01-15 16:30:24 +02:00
sphinx-pre-install
scripts: sphinx-pre-install: Fix ctex support on Debian
2022-01-07 09:33:13 -07:00
split-man.pl
tweewide: Fix most Shebang lines
2020-12-08 23:30:04 +09:00
stackdelta
…
stackusage
…
subarch.include
parisc: Fix compile failure when building 64-bit kernel natively
2021-09-01 21:52:02 +02:00
syscallhdr.sh
scripts: check duplicated syscall number in syscall table
2021-07-09 04:00:39 +09:00
syscallnr.sh
scripts: make some scripts executable
2021-08-10 09:13:25 +09:00
syscalltbl.sh
scripts: check duplicated syscall number in syscall table
2021-07-09 04:00:39 +09:00
tags.sh
scripts/tags: add space regexs to all regex_c
2021-11-26 16:58:55 +01:00
test_fortify.sh
fortify: Add compile-time FORTIFY_SOURCE tests
2021-10-18 12:28:52 -07:00
tools-support-relr.sh
Makefile: fix GDB warning with CONFIG_RELR
2021-06-08 13:09:34 +01:00
unifdef.c
…
ver_linux
Removed the oprofiled version option
2021-05-03 17:23:06 -06:00
xen-hypercalls.sh
scripts: make some scripts executable
2021-08-10 09:13:25 +09:00
xz_wrap.sh
kbuild: add variables for compression tools
2020-06-06 23:42:01 +09:00