wbrawner/toolbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
toolbox/doc/meson.build

33 lines
560 B
Meson
Raw Normal View History

Add manuals https://github.com/debarshiray/toolbox/pull/66
2019-02-28 17:07:24 +00:00
go_md2man_command = [
go_md2man,
'-in', '@INPUT@',
'-out', '@OUTPUT@',
]
manuals = [
'toolbox.1',
'toolbox-create.1',
'toolbox-enter.1',
Drop the Buildah dependency and the user-specific customized image This works by configuring the toolbox container after it has been created, instead of before. The toolbox script itself is mentioned as the entry point of the container, which does 'exec sleep +Inf' once the initialization is done. A new command 'init-container' was added to perform the initialization. It is primarily meant to be used as the entry point for all toolbox containers, and must be run inside the container that's to be initialized. It is not expected to be directly invoked by humans, and cannot be used on the host. As a result, the default name for the toolbox containers is now fedora-toolbox-<version-id>, not fedora-toolbox-<user>-<version-id>. For backwards compatibility, 'toolbox enter' and 'toolbox run' will continue to work with containers using the old naming scheme. https://github.com/debarshiray/toolbox/pull/160
2019-05-10 18:38:46 +00:00
'toolbox-init-container.1',
Improve the help or usage output A new help command has been added which either shows the toolbox(1) manual or a manual page for a specific command. The '--help' flag is now identical to the help command and can be placed after the COMMAND segment in the list of command line arguments. Due to a bizarre quirk in less(1) [1], the default pager used to render manuals on most systems, the man(1) invocations need the standard error stream to point to the controlling terminal, if any, to work. This interferes with the global redirection of standard error to /dev/null in the absence of the '--verbose' flag, and is worked around by redirecting to standard output instead. [1] It turns out that less(1) tries to open the controlling terminal device /dev/tty to get to the keyboard for accepting input. However, it doesn't have a controlling terminal when invoked via D-Bus to render a manual on the host. It then strangely falls back to using the standard error stream to get to the keyboard. https://github.com/debarshiray/toolbox/pull/200
2019-07-15 08:23:25 +00:00
'toolbox-help.1',
Add manuals https://github.com/debarshiray/toolbox/pull/66
2019-02-28 17:07:24 +00:00
'toolbox-list.1',
Add a reset command The 'reset' command is meant to factory reset the local Podman and Toolbox installations. Every now and then early adopters and testers of Toolbox have to do this when their local Podman state has gotten irrecoverably broken due to some Podman bug. It's useful to have a command that encapsulates all the steps to do a factory reset, as opposed to having to spell them out separately. It's easier to document, helps with user support, and can enable less opaque error messages that suggest a way forward when nothing is working. Since this command is meant to be used when the Podman installation is completely broken, it must avoid using any Podman commands at all costs. This is why it cannot use 'podman stop' to stop any running containers, nor can it use 'podman unshare' to delete ~/.local/share/containers when running rootless. Instead, it relies on the user rebooting the machine for the former, and uses newgidmap(1), newuidmap(1) and unshare(1) to reimplement 'podman unshare' for the latter. Note that when running as root, some care has been taken to avoid removing directories that might be owned by the operating system. eg., on Fedora /var/lib/containers/sigstore is owned by the containers-common RPM. https://github.com/containers/toolbox/pull/295
2019-10-11 12:05:15 +00:00
'toolbox-reset.1',
Add rm and rmi commands https://github.com/debarshiray/toolbox/pull/45
2019-02-19 15:59:19 +00:00
'toolbox-rm.1',
'toolbox-rmi.1',
Add a run command This makes 'toolbox enter' similar to 'toolbox run $SHELL'. The 'run' command is meant to spawn arbitrary binaries present inside the toolbox container. Therefore it doesn't make sense for it to fall back to /bin/bash, like it does for 'enter' if $SHELL is absent. It's expected that users might use 'run' to create ad-hoc *.desktop files. That's why it neither offers to create nor falls back to an existing container like 'enter' does, because such interactions can't happen when used in a *.desktop file. It's also a more advanced command that new users are less likely to be interested in. Hence, this shouldn't affect usability. Some changes by Debarshi Ray. https://github.com/debarshiray/toolbox/pull/76
2019-03-08 06:42:29 +00:00
'toolbox-run.1',
Add manuals https://github.com/debarshiray/toolbox/pull/66
2019-02-28 17:07:24 +00:00
]
foreach manual: manuals
input = manual + '.md'
output = manual
custom_target(
output,
command: go_md2man_command,
input: input,
install: true,
doc: Fix the installation of manuals The manuals shouldn't be installed in the top-level directory, but in one of the sub-directories corresponding to the relevant section. Fallout from 0a972dfccc9300fad267c52d6dafa721564c176b
2019-03-06 16:07:35 +00:00
install_dir: join_paths(get_option('mandir'), 'man1'),
Add manuals https://github.com/debarshiray/toolbox/pull/66
2019-02-28 17:07:24 +00:00
output: output,
)
endforeach
Reference in a new issue Copy permalink