Changes in Makefile

42367eca - tools: Remove redundant quiet setup

Thu, 13 Feb 2025 21:06:22 +0000

tools: Remove redundant quiet setupQ is exported from Makefile.include so it is not necessary to manuallyset it.Reviewed-by: Jiri Olsa Signed-off-by: Charlie Jenkins Acked-by: Andrii Nakryiko Acked-by: Quentin Monnet Cc: Adrian Hunter Cc: Alexander Shishkin Cc: Alexei Starovoitov Cc: Benjamin Tissoires Cc: Daniel Borkmann Cc: Daniel Lezcano Cc: Eduard Zingerman Cc: Hao Luo Cc: Ian Rogers Cc: Ingo Molnar Cc: Jiri Kosina Cc: John Fastabend Cc: Josh Poimboeuf Cc: KP Singh Cc: Lukasz Luba Cc: Mark Rutland Cc: Martin KaFai Lau Cc: Mykola Lysenko Cc: Namhyung Kim Cc: Peter Zijlstra Cc: Rafael J. Wysocki Cc: Shuah Khan Cc: Song Liu Cc: Stanislav Fomichev Cc: Steven Rostedt (VMware) Cc: Yonghong Song Cc: Zhang Rui Link: https://lore.kernel.org/r/20250213-quiet_tools-v3-2-07de4482a581@rivosinc.comSigned-off-by: Arnaldo Carvalho de Melo List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

f7b68543 - bpftool: Use simpler indentation in source rST for documentation

Sun, 31 Mar 2024 20:03:44 +0000

bpftool: Use simpler indentation in source rST for documentationThe rST manual pages for bpftool would use a mix of tabs and spaces forindentation. While this is the norm in C code, this is rather unusualfor rST documents, and over time we've seen many contributors use awrong level of indentation for documentation update.Let's fix bpftool's indentation in docs once and for all:- Let's use spaces, that are more common in rST files.- Remove one level of indentation for the synopsis, the command description, and the "see also" section. As a result, all sections start with the same indentation level in the generated man page.- Rewrap the paragraphs after the changes.There is no content change in this patch, only indentation andrewrapping changes. The wrapping in the generated source files for themanual pages is changed, but the pages displayed with "man" remain thesame, apart from the adjusted indentation level on relevant sections.[ Quentin: rebased on bpf-next, removed indent level for command description and options, updated synopsis, command summary, and "see also" sections. ]Signed-off-by: Rameez Rehman Signed-off-by: Quentin Monnet Signed-off-by: Daniel Borkmann Link: https://lore.kernel.org/bpf/20240331200346.29118-2-qmo@kernel.org List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

43448428 - bpftool: Add SPDX tags to RST documentation files

Mon, 15 Nov 2021 22:58:42 +0000

bpftool: Add SPDX tags to RST documentation filesMost files in the kernel repository have a SPDX tags. The files thatdon't have such a tag (or another license boilerplate) tend to fallunder the GPL-2.0 license. In the past, bpftool's Makefile (for example)has been marked as GPL-2.0 for that reason, when in fact all bpftool isdual-licensed.To prevent a similar confusion from happening with the RST documentationfiles for bpftool, let's explicitly mark all files as dual-licensed.Signed-off-by: Quentin Monnet Signed-off-by: Daniel Borkmann Link: https://lore.kernel.org/bpf/20211115225844.33943-2-quentin@isovalent.com List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

48f5aef4 - bpftool: Remove inclusion of utilities.mak from Makefiles

Wed, 10 Nov 2021 11:46:28 +0000

bpftool: Remove inclusion of utilities.mak from MakefilesBpftool's Makefile, and the Makefile for its documentation, both includescripts/utilities.mak, but they use none of the items defined in thisfile. Remove the includes.Fixes: 71bb428fe2c1 ("tools: bpf: add bpftool")Signed-off-by: Quentin Monnet Signed-off-by: Andrii Nakryiko Link: https://lore.kernel.org/bpf/20211110114632.24537-3-quentin@isovalent.com List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

1a8b597d - bpftool: Fix SPDX tag for Makefiles and .gitignore

Fri, 05 Nov 2021 22:19:04 +0000

bpftool: Fix SPDX tag for Makefiles and .gitignoreBpftool is dual-licensed under GPLv2 and BSD-2-Clause. In commit907b22365115 ("tools: bpftool: dual license all files") we made surethat all its source files were indeed covered by the two licenses, andthat they had the correct SPDX tags.However, bpftool's Makefile, the Makefile for its documentation, and the.gitignore file were skipped at the time (their GPL-2.0-only tag wasadded later). Let's update the tags.Signed-off-by: Quentin Monnet Signed-off-by: Alexei Starovoitov Acked-by: Andrii Nakryiko Acked-by: Tobias Klauser Acked-by: Joe Stringer Acked-by: Song Liu Acked-by: Jean-Philippe Brucker Acked-by: Jesper Dangaard Brouer Acked-by: Jakub Kicinski Link: https://lore.kernel.org/bpf/20211105221904.3536-1-quentin@isovalent.com List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

a01d935b - tools/bpf: Remove bpf-helpers from bpftool docs

Tue, 02 Mar 2021 17:19:43 +0000

tools/bpf: Remove bpf-helpers from bpftool docsThis logic is used for validating the manual pages from selftests, somove the infra under tools/testing/selftests/bpf/ and rely on selftestsfor validation rather than tying it into the bpftool build.Signed-off-by: Joe Stringer Signed-off-by: Alexei Starovoitov Reviewed-by: Quentin Monnet Acked-by: Toke Høiland-Jørgensen Link: https://lore.kernel.org/bpf/20210302171947.2268128-12-joe@cilium.io List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

63bea244 - bpftool: Fix build failure

Mon, 14 Sep 2020 18:31:10 +0000

bpftool: Fix build failureWhen building bpf selftests like make -C tools/testing/selftests/bpf -j20I hit the following errors: ... GEN /net-next/tools/testing/selftests/bpf/tools/build/bpftool/Documentation/bpftool-gen.8 :75: (WARNING/2) Block quote ends without a blank line; unexpected unindent. :71: (WARNING/2) Literal block ends without a blank line; unexpected unindent. :85: (WARNING/2) Literal block ends without a blank line; unexpected unindent. :57: (WARNING/2) Block quote ends without a blank line; unexpected unindent. :66: (WARNING/2) Literal block ends without a blank line; unexpected unindent. :109: (WARNING/2) Literal block ends without a blank line; unexpected unindent. :175: (WARNING/2) Literal block ends without a blank line; unexpected unindent. :273: (WARNING/2) Literal block ends without a blank line; unexpected unindent. make[1]: *** [/net-next/tools/testing/selftests/bpf/tools/build/bpftool/Documentation/bpftool-perf.8] Error 12 make[1]: *** Waiting for unfinished jobs.... make[1]: *** [/net-next/tools/testing/selftests/bpf/tools/build/bpftool/Documentation/bpftool-iter.8] Error 12 make[1]: *** [/net-next/tools/testing/selftests/bpf/tools/build/bpftool/Documentation/bpftool-struct_ops.8] Error 12 ...I am using: -bash-4.4$ rst2man --version rst2man (Docutils 0.11 [repository], Python 2.7.5, on linux2) -bash-4.4$The Makefile generated final .rst file (e.g., bpftool-cgroup.rst) looks like ... ID AttachType AttachFlags Name \n SEE ALSO\n========\n\t**bpf**\ (2),\n\t**bpf-helpers**\ (7),\n\t**bpftool**\ (8),\n\t**bpftool-btf**\ (8),\n\t**bpftool-feature**\ (8),\n\t**bpftool-gen**\ (8),\n\t**bpftool-iter**\ (8),\n\t**bpftool-link**\ (8),\n\t**bpftool-map**\ (8),\n\t**bpftool-net**\ (8),\n\t**bpftool-perf**\ (8),\n\t**bpftool-prog**\ (8),\n\t**bpftool-struct_ops**\ (8)\nThe rst2man generated .8 file looks likeLiteral block ends without a blank line; unexpected unindent. .sp n SEEALSOn========nt**bpf**(2),nt**bpf\-helpers**(7),nt**bpftool**(8),nt**bpftool\-btf**(8),nt** bpftool\-feature**(8),nt**bpftool\-gen**(8),nt**bpftool\-iter**(8),nt**bpftool\-link**(8),nt** bpftool\-map**(8),nt**bpftool\-net**(8),nt**bpftool\-perf**(8),nt**bpftool\-prog**(8),nt** bpftool\-struct_ops**(8)nLooks like that particular version of rst2man prefers to have actual new lineinstead of \n.Since `echo -e` may not be available in some environment, let us use `printf`.Format string "%b" is used for `printf` to ensure all escape characters areinterpretted properly.Fixes: 18841da98100 ("tools: bpftool: Automate generation for "SEE ALSO" sections in man pages")Suggested-by: Andrii Nakryiko Signed-off-by: Yonghong Song Signed-off-by: Alexei Starovoitov Acked-by: Song Liu Acked-by: Andrii Nakryiko Cc: Quentin Monnet Link: https://lore.kernel.org/bpf/20200914183110.999906-1-yhs@fb.com List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

18841da9 - tools: bpftool: Automate generation for "SEE ALSO" sections in man pages

Thu, 10 Sep 2020 20:39:35 +0000

tools: bpftool: Automate generation for "SEE ALSO" sections in man pagesThe "SEE ALSO" sections of bpftool's manual pages refer to bpf(2),bpf-helpers(7), then all existing bpftool man pages (save the currentone).This leads to nearly-identical lists being duplicated in all manualpages. Ideally, when a new page is created, all lists should be updatedaccordingly, but this has led to omissions and inconsistencies multipletimes in the past.Let's take it out of the RST files and generate the "SEE ALSO" sectionsautomatically in the Makefile when generating the man pages. The listsare not really useful in the RST anyway because all other pages areavailable in the same directory.v3:- Fix conflict with a previous patchset that introduced RST2MAN_OPTS variable passed to rst2man.v2:- Use "echo -n" instead of "printf" in Makefile, to avoid any risk of passing a format string directly to the command.Signed-off-by: Quentin Monnet Signed-off-by: Alexei Starovoitov Acked-by: Andrii Nakryiko Link: https://lore.kernel.org/bpf/20200910203935.25304-1-quentin@isovalent.com List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

f28ef96d - tools: bpftool: Include common options from separate file

Wed, 09 Sep 2020 16:24:59 +0000

tools: bpftool: Include common options from separate fileNearly all man pages for bpftool have the same common set of optionflags (--help, --version, --json, --pretty, --debug). The description isduplicated across all the pages, which is more difficult to maintain ifthe description of an option changes. It may also be confusing to sortout what options are not "common" and should not be copied when creatingnew manual pages.Let's move the description for those common options to a separate file,which is included with a RST directive when generating the man pages.Signed-off-by: Quentin Monnet Signed-off-by: Alexei Starovoitov Acked-by: Andrii Nakryiko Link: https://lore.kernel.org/bpf/20200909162500.17010-3-quentin@isovalent.com List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

16f3ddfb - tools: bpftool: Log info-level messages when building bpftool man pages

Wed, 09 Sep 2020 16:22:50 +0000

tools: bpftool: Log info-level messages when building bpftool man pagesTo build man pages for bpftool (and for eBPF helper functions), rst2mancan log different levels of information. Let's make it log all levelsto keep the RST files clean.Doing so, rst2man complains about double colons, used for literalblocks, that look like underlines for section titles. Let's add thenecessary blank lines.v2:- Use "--verbose" instead of "-r 1" (same behaviour but more readable).- Pass it through a RST2MAN_OPTS variable so we can easily pass other options too.Signed-off-by: Quentin Monnet Signed-off-by: Alexei Starovoitov Acked-by: Andrii Nakryiko Link: https://lore.kernel.org/bpf/20200909162251.15498-2-quentin@isovalent.com List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

ec8f24b7 - treewide: Add SPDX license identifier - Makefile/Kconfig

Sun, 19 May 2019 12:07:45 +0000

treewide: Add SPDX license identifier - Makefile/KconfigAdd SPDX license identifiers to all Make/Kconfig files which: - Have no license information of any formThese files fall under the project license, GPL v2 only. The resulting SPDXlicense identifier is: GPL-2.0-onlySigned-off-by: Thomas Gleixner Signed-off-by: Greg Kroah-Hartman List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

86f7d85c - tools: bpf: build and install man page for eBPF helpers from bpftool/

Thu, 12 Jul 2018 11:52:24 +0000

tools: bpf: build and install man page for eBPF helpers from bpftool/Provide a new Makefile.helpers in tools/bpf, in order to build andinstall the man page for eBPF helpers. This Makefile is also included inthe one used to build bpftool documentation, so that it can be calledeither on its own (cd tools/bpf && make -f Makefile.helpers) or frombpftool directory (cd tools/bpf/bpftool && make doc, orcd tools/bpf/bpftool/Documentation && make helpers).Makefile.helpers is not added directly to bpftool to avoid changing itsMakefile too much (helpers are not 100% directly related with bpftool).But the possibility to build the page from bpftool directory makes usable to package the helpers man page with bpftool, and to install italong with bpftool documentation, so that the doc for helpers becomeseasily available to developers through the "man" program.Cc: linux-man@vger.kernel.orgSuggested-by: Daniel Borkmann Signed-off-by: Quentin Monnet Reviewed-by: Jakub Kicinski Signed-off-by: Daniel Borkmann List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

92426820 - tools: bpftool: exit doc Makefile early if rst2man is not available

Thu, 08 Feb 2018 04:27:14 +0000

tools: bpftool: exit doc Makefile early if rst2man is not availableIf rst2man is not available on the system, running `make doc` from thebpftool directory fails with an error message. However, it creates emptymanual pages (.8 files in this case). A subsequent call to `makedoc-install` would then succeed and install those empty man pages on thesystem.To prevent this, raise a Makefile error and exit immediately if rst2manis not available before generating the pages from the rst documentation.Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")Reported-by: Jason van Aaardt Signed-off-by: Quentin Monnet Reviewed-by: Jakub Kicinski Signed-off-by: Daniel Borkmann List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

d3244248 - tools: bpftool: create "uninstall", "doc-uninstall" make targets

Thu, 07 Dec 2017 23:00:18 +0000

tools: bpftool: create "uninstall", "doc-uninstall" make targetsCreate two targets to remove executable and documentation that wouldhave been previously installed with `make install` and `makedoc-install`.Also create a "QUIET_UNINST" helper in tools/scripts/Makefile.include.Do not attempt to remove directories /usr/local/sbin and/usr/share/bash-completions/completions, even if they are empty, asthose specific directories probably already existed on the system beforewe installed the program, and we do not wish to break other makefilesthat might assume their existence. Do remvoe /usr/local/share/man/man8if empty however, as this directory does not seem to exist by default.Signed-off-by: Quentin Monnet Signed-off-by: Daniel Borkmann List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

658e85aa - tools: bpftool: harmonise Makefile and Documentation/Makefile

Thu, 07 Dec 2017 23:00:17 +0000

tools: bpftool: harmonise Makefile and Documentation/MakefileSeveral minor fixes and harmonisation items for Makefiles:* Use the same mechanism for verbose/non-verbose output in two files ("$(Q)"), for all commands.* Use calls to "QUIET_INSTALL" and equivalent in Makefile. In particular, use "call(descend, ...)" instead of "make -C" to run documentation targets.* Add a "doc-clean" target, aligned on "doc" and "doc-install".* Make "install" target in Makefile depend on "bpftool".* Remove condition on DESTDIR to initialise prefix in doc Makefile.* Remove modification of VPATH based on OUTPUT, it is unused.* Formatting: harmonise spaces around equal signs.* Make install path for man pages /usr/local/man instead of /usr/local/share/man (respects the Makefile conventions, and the latter is usually a symbolic link to the former anyway).* Do not erase prefix if set by user in bpftool Makefile.* Fix install target for bpftool: append DESTDIR to install path.Signed-off-by: Quentin Monnet Signed-off-by: Daniel Borkmann List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

507e590d - tools: bpftool: unify installation directories

Wed, 29 Nov 2017 01:44:32 +0000

tools: bpftool: unify installation directoriesPrograms and documentation not managed by package manager are generallyinstalled under /usr/local/, instead of the user's home directory. Inparticular, `man` is generally able to find manual pages under`/usr/local/share/man`.bpftool generally follows perf's example, and perf installs to homedirectory. However bpftool requires root credentials, so it seemssensible to follow the more common convention of installing files under/usr/local instead. So, make /usr/local the default prefix forinstalling the binary with `make install`, and the documentation with`make doc-install`. Also, create /usr/local/sbin if it does not exist.Note that the bash-completion file, however, is still installed under/usr/share/bash-completion/completions, as the default setup for bashdoes not attempt to load completion files under /usr/local/.Reported-by: David Beckett Signed-off-by: Quentin Monnet Acked-by: Jakub Kicinski Signed-off-by: Daniel Borkmann List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile

ff69c21a - tools: bpftool: add documentation

Thu, 05 Oct 2017 03:10:05 +0000

tools: bpftool: add documentationAdd documentation for bpftool. Separate files for each subcommand.Use rst format. Documentation is compiled into man pages usingrst2man.Signed-off-by: David Beckett Signed-off-by: Jakub Kicinski Acked-by: Alexei Starovoitov Acked-by: Daniel Borkmann Signed-off-by: David S. Miller List of files: /linux-6.15/tools/bpf/bpftool/Documentation/Makefile