Browse Source

supports documentation at build time

2.3.1
obarun 2 years ago
parent
commit
2b211de991
  1. 8
      INSTALL.md
  2. 20
      Makefile
  3. 8
      configure
  4. 6
      doc/boot@.md

8
INSTALL.md

@ -12,6 +12,8 @@ This software will install on any operating system that implements POSIX.1-2008,
`./configure && make && sudo make install` will work for most users.
Note: the man and html documentation pages will always be generated if *lowdown* is installed on your system. However, if you don't ask to build the documentation the final `DESTDIR` directory will do not contains any documentation at all.
## Customization
You can customize paths via flags given to configure. See `./configure --help` for a list of all available configure options.
@ -21,15 +23,15 @@ You can customize paths via flags given to configure. See `./configure --help` f
- execline version 2.6.0.2 or later: http://skarnet.org/software/execline/
- s6 version 2.9.1.0 or later: http://skarnet.org/software/s6/
- s6-rc version 0.5.1.2 or later: http://skarnet.org/software/s6-rc/
- 66 version 0.4.0.1 or later: https://framagit.org/Obarun/66/
- 66-tools version 0.0.6.0 or later: https://framagit.org/Obarun/66-tools/
- 66 version 0.5.0.0 or later: https://framagit.org/Obarun/66/
- 66-tools version 0.0.6.1 or later: https://framagit.org/Obarun/66-tools/
- s6-linux-utils version 2.5.1.2 or later: http://skarnet.org/software/s6-linux-utils/
- s6-portable-utils version 2.2.2.2 or later: http://skarnet.org/software/s6-portable-utils/
- bash
- iproute2
- kmod
- optional dependencies:
* iptables
* iptables,nftables,ebtables,arptables
* dmraid
* lvm2
* btrfs-progs

20
Makefile

@ -13,15 +13,25 @@ endif
-include config.mak
include package/targets.mak
LOWDOWN := $(shell type -p lowdown)
ifdef LOWDOWN
GENERATE_HTML := $(shell doc/make-html.sh)
GENERATE_MAN := $(shell doc/make-man.sh)
endif
INSTALL_HTML := $(wildcard doc/html/*.html)
INSTALL_MAN := $(wildcard doc/man/*/*)
INSTALL := ./tools/install.sh
install: install-script install-service install-service-module install-service-instance-module install-configure install-rc-local
install: install-script install-service install-service-module install-service-instance-module install-configure install-rc-local install-html install-man
install-script: $(SCRIPT_TARGET:module/boot@/configure/%=$(DESTDIR)$(script_directory)/%)
install-service: $(SERVICE_TARGET:service/%=$(DESTDIR)$(service_directory)/%)
install-service-module: $(MODULE_TARGET:module/boot@/service/%=$(DESTDIR)$(module_directory)/boot@/service/%)
install-service-instance-module: $(MODULE_INSTANCE_TARGET:module/boot@/service@/%=$(DESTDIR)$(module_directory)/boot@/service@/%)
install-configure: $(MODULE_CONFIGURE_TARGET:module/boot@/configure/configure=$(DESTDIR)$(module_directory)/boot@/configure/configure)
install-rc-local: $(SKEL_SCRIPT_TARGET:module/boot@/configure/rc.local=$(DESTDIR)$(skel_directory)/rc.local)
install-html: $(INSTALL_HTML:doc/html/%.html=$(DESTDIR)$(datarootdir)/doc/$(package)/%.html)
install-man: install-man1
install-man1: $(INSTALL_MAN:doc/man/man1/%.1=$(DESTDIR)$(mandir)/man1/%.1)
$(DESTDIR)$(script_directory)/%: module/boot@/configure/%
exec $(INSTALL) -D -m 755 $< $@
@ -88,6 +98,14 @@ $(DESTDIR)$(service_directory)/%: service/%
-e "s,@POPULATE_RUN@,$(POPULATE_RUN)," \
-e "s,@POPULATE_TMP@,$(POPULATE_TMP)," $@
$(DESTDIR)$(datarootdir)/doc/$(package)/%.html: doc/html/%.html
$(INSTALL) -D -m 644 $< $@ && \
sed -e 's,%%skel_directory%%,$(skel_directory),g' $< > $@
$(DESTDIR)$(mandir)/man1/%.1: doc/man/man1/%.1
$(INSTALL) -D -m 644 $< $@ && \
sed -e 's,%%skel_directory%%,$(skel_directory),g' $< > $@
version:
@echo $(version)

8
configure vendored

@ -17,6 +17,7 @@ Fine tuning of the installation directories:
--libdir=LIBDIR static library files [PREFIX/lib/$package_macro_dir]
--sysconfdir=SYSDIR global configuration files [/etc]
--datarootdir=DATAROOTDIR read-only architecture-independent data root [PREFIX/share]
--mandir=DIR man documentation [$datarootdir/man]
--livedir=DIR 66 default live directory [/run/66]
--with-system-service=DIR 66 service intallation directory [DATAROOTDIR/$package_macro_dir/service]
--with-system-module=DIR 66 module intallation directory [DATAROOTDIR/$package_macro_dir/module]
@ -133,6 +134,7 @@ bindir='$exec_prefix/bin'
libdir='$prefix/lib/$package_macro_dir'
sysconfdir='/etc'
datarootdir='$prefix/share'
mandir='$datarootdir/man'
livedir='/run/66'
service_directory='$datarootdir/$package_macro_dir/service'
module_directory='$datarootdir/$package_macro_dir/module'
@ -190,6 +192,7 @@ for arg ; do
--libdir=*) libdir=${arg#*=} ;;
--sysconfdir=*) sysconfdir=${arg#*=} ;;
--datarootdir=*) datarootdir=${arg#*=} ;;
--mandir=*) mandir=${arg#*=} ;;
--livedir=*) livedir=${arg#*=} ;;
--with-system-service=*) service_directory=${arg#*=} ;;
--with-system-module=*) module_directory=${arg#*=} ;;
@ -265,7 +268,7 @@ fi
# Expand installation directories
stripdir prefix
for i in exec_prefix bindir libdir sysconfdir datarootdir livedir \
for i in exec_prefix bindir libdir sysconfdir datarootdir mandir livedir \
service_directory module_directory script_directory skel_directory adm_conf ; do
eval tmp=\${$i}
eval $i=$tmp
@ -280,7 +283,7 @@ for i in adm_conf skel_directory; do
done
stripdir datarootdir
for i in service_directory module_directory script_directory; do
for i in service_directory module_directory script_directory mandir; do
eval tmp=\${$i}
eval $i=$tmp
stripdir $i
@ -331,6 +334,7 @@ bindir := $bindir
libdir := $libdir
sysconfdir := $sysconfdir
datarootdir := $datarootdir
mandir := $mandir
livedir := $livedir
service_directory := $service_directory
module_directory := $module_directory

6
doc/boot@.md

@ -17,7 +17,7 @@ For example:
# 66-tree -n boot
# 66-enable -t boot boot@system
```
The name of the tree need to match the name set at your `TREE=` *key=value* pair define into the `/etc/66/init.conf` file.
The name of the tree need to match the name set at your `TREE=` *key=value* pair define into the `%%skel_directory%%/init.conf` file.
Do not marks this tree enabled with the `66-tree -E` option. The [66-init](https://web.obarun.org/software/66/66-tree.html) will take care for you about this special tree and starts it automatically.
@ -130,7 +130,7 @@ Two differents kind of variable is used:
- **LOCAL**:
- type: boolean.
- description: use the `/etc/66/rc.local` script. This script is launched at the end of the boot procedure. The file ***must*** exist on your system and executable with a correct definition of the shebang at the start of the script.
- description: use the `%%skel_directory%%/rc.local` script. This script is launched at the end of the boot procedure. The file ***must*** exist on your system and executable with a correct definition of the shebang at the start of the script.
- **CONTAINER**:
- type: boolean.
@ -199,7 +199,7 @@ Two differents kind of variable is used:
- **POPULATE_SYS**:
- type: boolean
- decription: mount the `/sys/firmware/efi/efivars`, `/sys/fs/fuse/connections`,`/sys/kernel/config`, `/sys/kernel/debug` and `/sys/kernel/security` directory.
- decription: mount the `/sys/firmware/efi/efivars`, `/sys/fs/fuse/connections`, `/sys/kernel/config`, `/sys/kernel/debug` and `/sys/kernel/security` directory.
- **POPULATE_DEV**:
- type: boolean

Loading…
Cancel
Save