github-starred/firejail
2
0
Fork 0
mirror of https://github.com/netblue30/firejail.git synced 2026-05-15 14:16:14 -06:00
Code Issues 531 Projects Packages Wiki Activity Actions 6

build: simplify code related to man pages

Browse source 
Simplify the main targets and use wildcards instead of repeating the
filenames manually.

Also, restore the `man` target and building only when `HAVE_MAN` is
enabled.

Note: Make automatically removes intermediate files (.1 and .5), so in
general only the .gz files have to be cleaned.

Commands used to rename the man pages:

    cd src/man
    git mv firecfg.txt firecfg.1.in
    git mv firejail-login.txt firejail-login.5.in
    git mv firejail-profile.txt firejail-profile.5.in
    git mv firejail-users.txt firejail-users.5.in
    git mv firejail.txt firejail.1.in
    git mv firemon.txt firemon.1.in
    git mv jailcheck.txt jailcheck.1.in

This is kind of a follow-up to commit 9e206b7f2 ("rework src/man
Makefile", 2023-07-07).
This commit is contained in:
Kelvin M. Klann 2023-07-12 01:55:07 -03:00
parent 80eb28483f
commit 76bd5ad0f8
12 changed files with 48 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

19
.gitignore vendored
View file

@ -6,9 +6,9 @@
*.rpm
*.gcda
*.gcno
*.gz
*.DS_Store
.directory
*.man
.vscode
/firejail-*/
autom4te.cache/
@ -20,14 +20,6 @@ contrib/syntax/files/example
contrib/syntax/files/firejail-profile.lang
contrib/syntax/files/firejail.vim
firejail-*.tar.xz
firejail-login.5
firejail-profile.5
firejail-config.5
firejail-users.5
firejail.1
firemon.1
firecfg.1
jailcheck.1
src/fnettrace-dns/fnettrace-dns
src/fnettrace-sni/fnettrace-sni
src/fnettrace-icmp/fnettrace-icmp
@ -68,10 +60,5 @@ __pycache__
*.pyc
*.pyo
src/fnettrace/static-ip-map
src/man/firecfg.1.gz
src/man/firejail-login.5.gz
src/man/firejail-profile.5.gz
src/man/firejail-users.5.gz
src/man/firejail.1.gz
src/man/firemon.1.gz
src/man/jailcheck.1.gz
src/man/*.1
src/man/*.5

33
Makefile
View file

@ -2,6 +2,10 @@
ROOT = .
-include config.mk
ifneq ($(HAVE_MAN),no)
MAN_TARGET = man
endif
ifneq ($(HAVE_CONTRIB_INSTALL),no)
CONTRIB_TARGET = contrib
endif
@ -14,11 +18,16 @@ SBOX_APPS_NON_DUMPABLE = src/fcopy/fcopy src/fldd/fldd src/fnet/fnet src/fnetfil
SBOX_APPS_NON_DUMPABLE += src/fsec-optimize/fsec-optimize src/fsec-print/fsec-print src/fseccomp/fseccomp
SBOX_APPS_NON_DUMPABLE += src/fnettrace/fnettrace src/fnettrace-dns/fnettrace-dns src/fnettrace-sni/fnettrace-sni
SBOX_APPS_NON_DUMPABLE += src/fnettrace-icmp/fnettrace-icmp
MYDIRS = src/lib src/man $(COMPLETIONDIRS)
MYDIRS = src/lib $(COMPLETIONDIRS)
MYLIBS = src/libpostexecseccomp/libpostexecseccomp.so src/libtrace/libtrace.so src/libtracelog/libtracelog.so
COMPLETIONS = src/zsh_completion/_firejail src/bash_completion/firejail.bash_completion
SECCOMP_FILTERS = seccomp seccomp.debug seccomp.32 seccomp.block_secondary seccomp.mdwx seccomp.mdwx.32 seccomp.namespaces seccomp.namespaces.32
MANPAGES1_IN := $(sort $(wildcard src/man/*.1.in))
MANPAGES5_IN := $(sort $(wildcard src/man/*.5.in))
MANPAGES1_GZ := $(MANPAGES1_IN:.in=.gz)
MANPAGES5_GZ := $(MANPAGES5_IN:.in=.gz)
SYSCALL_HEADERS := $(sort $(wildcard src/include/syscall*.h))
# Lists of keywords used in profiles; used for generating syntax files.
@ -37,7 +46,7 @@ SYNTAX_FILES := $(SYNTAX_FILES_IN:.in=)
ALL_ITEMS = $(APPS) $(SBOX_APPS) $(SBOX_APPS_NON_DUMPABLE) $(MYLIBS)
.PHONY: all
all: all_items mydirs filters $(CONTRIB_TARGET)
all: all_items mydirs filters $(MAN_TARGET) $(CONTRIB_TARGET)
config.mk config.sh:
@printf 'error: run ./configure to generate %s\n' "$@" >&2
@ -82,6 +91,10 @@ seccomp.namespaces: src/fseccomp/fseccomp
seccomp.namespaces.32: src/fseccomp/fseccomp
src/fseccomp/fseccomp restrict-namespaces seccomp.namespaces.32 cgroup,ipc,net,mnt,pid,time,user,uts
.PHONY: man
man:
$(MAKE) -C src/man
# Makes all targets in contrib/
.PHONY: contrib
contrib: syntax
@ -150,6 +163,7 @@ clean:
for dir in $$(dirname $(ALL_ITEMS)) $(MYDIRS); do \
$(MAKE) -C $$dir clean; \
done
$(MAKE) -C src/man clean
$(MAKE) -C test clean
rm -f $(SECCOMP_FILTERS)
rm -f firejail*.rpm
@ -242,13 +256,8 @@ endif
ifneq ($(HAVE_MAN),no)
# man pages
install -m 0755 -d $(DESTDIR)$(mandir)/man1 $(DESTDIR)$(mandir)/man5
install -m 0644 src/man/firejail.1.gz $(DESTDIR)$(mandir)/man1/
install -m 0644 src/man/firemon.1.gz $(DESTDIR)$(mandir)/man1/
install -m 0644 src/man/firecfg.1.gz $(DESTDIR)$(mandir)/man1/
install -m 0644 src/man/jailcheck.1.gz $(DESTDIR)$(mandir)/man1/
install -m 0644 src/man/firejail-login.5.gz $(DESTDIR)$(mandir)/man5/
install -m 0644 src/man/firejail-users.5.gz $(DESTDIR)$(mandir)/man5/
install -m 0644 src/man/firejail-profile.5.gz $(DESTDIR)$(mandir)/man5/
install -m 0644 $(MANPAGES1_GZ) $(DESTDIR)$(mandir)/man1/
install -m 0644 $(MANPAGES5_GZ) $(DESTDIR)$(mandir)/man5/
endif
# bash completion
install -m 0755 -d $(DESTDIR)$(datarootdir)/bash-completion/completions
@ -276,10 +285,8 @@ uninstall: config.mk
rm -f $(DESTDIR)$(bindir)/jailcheck
rm -fr $(DESTDIR)$(libdir)/firejail
rm -fr $(DESTDIR)$(datarootdir)/doc/firejail
for man in $(MANPAGES); do \
rm -f $(DESTDIR)$(mandir)/man5/$$man*; \
rm -f $(DESTDIR)$(mandir)/man1/$$man*; \
done
rm -f $(addprefix $(DESTDIR)$(mandir)/man1/,$(notdir $(MANPAGES1_GZ)))
rm -f $(addprefix $(DESTDIR)$(mandir)/man5/,$(notdir $(MANPAGES5_GZ)))
rm -f $(DESTDIR)$(datarootdir)/bash-completion/completions/firejail
rm -f $(DESTDIR)$(datarootdir)/bash-completion/completions/firemon
rm -f $(DESTDIR)$(datarootdir)/bash-completion/completions/firecfg

5
RELNOTES
View file

@ -21,8 +21,6 @@ firejail (0.9.73) baseline; urgency=low
#5618)
* bugfix: fix --hostname and --hosts-file commands
* bugfix: arp.c: ensure positive timeout on select(2) (#5806)
* build: fixed problem with seccomp filters and man pages built every
time when running make
* build: auto-generate syntax files (#5627)
* build: mark all phony targets as such (#5637)
* build: mkdeb.sh: pass all arguments to ./configure (#5654)
@ -32,6 +30,9 @@ firejail (0.9.73) baseline; urgency=low
* build: remove -mretpoline and NO_EXTRA_CFLAGS (#5859)
* build: disable all built-in implicit make rules (#5864)
* build: organize and standardize make vars and targets (#5866)
* build: fix seccomp filters and man pages always being rebuilt when running
make
* build: simplify code related to man pages (#5898)
* ci: always update the package db before installing packages (#5742)
* ci: fix codeql unable to download its own bundle (#5783)
* ci: split configure/build/install commands on gitlab (#5784)

53
src/man/Makefile
View file

@ -2,44 +2,25 @@
ROOT = ../..
-include $(ROOT)/config.mk
all: firecfg.1.gz firejail.1.gz firejail-login.5.gz firejail-users.5.gz firejail-profile.5.gz firemon.1.gz jailcheck.1.gz
MOD_DIR := $(ROOT)/src/man
MANPAGES_IN := $(sort $(wildcard $(MOD_DIR)/*.in))
MANPAGES_GZ := $(MANPAGES_IN:.in=.gz)
TARGET = $(MANPAGES_GZ)
#firecfg.1.gz: firecfg.txt
# gawk -f ./preproc.awk -- $(MANFLAGS) < $< > firecfg.1
# ./mkman.sh $(VERSION) firecfg.1
# gzip -n9 firecfg.1
.PHONY: all
all: $(TARGET)
# a small function to build a manpage
define build
gawk -f ./preproc.awk -- $(MANFLAGS) < $1 > $2
./mkman.sh $(VERSION) ./$2
rm -f $2.gz
gzip -n9 $2
endef
# foo.1: foo.1.in
$(MOD_DIR)/%: $(MOD_DIR)/%.in $(ROOT)/config.mk
@printf 'Generating %s from %s\n' $@ $<
@gawk -f $(MOD_DIR)/preproc.awk -- $(MANFLAGS) <$< | \
$(MOD_DIR)/mkman.sh $(VERSION) >$@
firecfg.1.gz: firecfg.txt
$(call build,firecfg.txt,firecfg.1)
firejail.1.gz: firejail.txt
$(call build,firejail.txt,firejail.1)
firejail-login.5.gz: firejail-login.txt
$(call build,firejail-login.txt,firejail-login.5)
firejail-users.5.gz: firejail-users.txt
$(call build,firejail-users.txt,firejail-users.5)
firejail-profile.5.gz: firejail-profile.txt
$(call build,firejail-profile.txt,firejail-profile.5)
firemon.1.gz: firemon.txt
$(call build,firemon.txt,firemon.1)
jailcheck.1.gz: jailcheck.txt
$(call build,jailcheck.txt,jailcheck.1)
# foo.1.gz: foo.1
$(MOD_DIR)/%.gz: $(MOD_DIR)/%
@printf 'Generating %s from %s\n' $@ $<
@rm -f $@
@gzip -n9 $<
.PHONY: clean
clean:; rm -fr *.1 *.5 *.gz
.PHONY: distclean
distclean: clean
clean:; rm -f *.1 *.5 *.gz

0
src/man/firecfg.txt → src/man/firecfg.1.in
View file

0
src/man/firejail-login.txt → src/man/firejail-login.5.in
View file

0
src/man/firejail-profile.txt → src/man/firejail-profile.5.in
View file

0
src/man/firejail-users.txt → src/man/firejail-users.5.in
View file

0
src/man/firejail.txt → src/man/firejail.1.in
View file

0
src/man/firemon.txt → src/man/firemon.1.in
View file

0
src/man/jailcheck.txt → src/man/jailcheck.1.in
View file

8
src/man/mkman.sh
View file

@ -5,8 +5,10 @@
set -e
sed -i "s/VERSION/$1/g" "$2"
MONTH="$(LC_ALL=C date -u --date="@${SOURCE_DATE_EPOCH:-$(date +%s)}" +%b)"
sed -i "s/MONTH/$MONTH/g" "$2"
YEAR="$(LC_ALL=C date -u --date="@${SOURCE_DATE_EPOCH:-$(date +%s)}" +%Y)"
sed -i "s/YEAR/$YEAR/g" "$2"
sed \
-e "s/VERSION/$1/g" \
-e "s/MONTH/$MONTH/g" \
-e "s/YEAR/$YEAR/g"