1
1
mirror of https://github.com/systemd/systemd-stable.git synced 2024-12-23 17:34:00 +03:00

generators: accept one or three args, do not write to /tmp

Since the general generator logic was established in the rewrite in
07719a21b6, generators would always write to /tmp
by default. I think this not a good default at all, because generators write a
bunch of files and would create a mess in /tmp. And for debugging, one
generally needs to remove all the files in the output directory, because
generators will complain in the output paths are already present. Thus the
approach of disabling console logging and writing many files to /tmp when
invoked with no arguments is not nice, so let's disallow operation with no
args.

But when debugging, one generally does not care about the separate output dirs
(most generators use only one). Thus the general pattern I use is something
like:
  rm -rf /tmp/x && mkdir /tmp/x && build/some-generator /tmp/{x,x,x}
This commit allows only one directory to be specified and simplifies this to:
  rm -rf /tmp/x && mkdir /tmp/x && build/some-generator /tmp/x
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2022-07-13 18:19:04 +02:00
parent b711a9ee18
commit 17021368fc
2 changed files with 17 additions and 15 deletions

View File

@ -26,8 +26,8 @@
<cmdsynopsis> <cmdsynopsis>
<command index='false'>/path/to/generator</command> <command index='false'>/path/to/generator</command>
<arg choice="plain"><replaceable>normal-dir</replaceable></arg> <arg choice="plain"><replaceable>normal-dir</replaceable></arg>
<arg choice="plain"><replaceable>early-dir</replaceable></arg> <arg choice="option"><replaceable>early-dir</replaceable></arg>
<arg choice="plain"><replaceable>late-dir</replaceable></arg> <arg choice="option"><replaceable>late-dir</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
<para> <para>
@ -56,13 +56,13 @@
that they can extend the unit file hierarchy the service manager subsequently loads and operates that they can extend the unit file hierarchy the service manager subsequently loads and operates
on.</para> on.</para>
<para>Each generator is called with three directory paths that are to be used for generator output. In <para><command>systemd</command> will call each generator with three directory paths that are to be used
these three directories, generators may dynamically generate unit files (regular ones, instances, as well for generator output. In these three directories, generators may dynamically generate unit files (regular
as templates), unit file <filename>.d/</filename> drop-ins, and create symbolic links to unit files to ones, instances, as well as templates), unit file <filename>.d/</filename> drop-ins, and create symbolic
add additional dependencies, create aliases, or instantiate existing templates. Those directories are links to unit files to add additional dependencies, create aliases, or instantiate existing templates.
included in the unit load path of Those directories are included in the unit load path, allowing generated configuration to extend or
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, allowing override existing definitions. For tests, generators may be called with just one argument; the generator
generated configuration to extend or override existing definitions.</para> should assume that all three paths are the same in that case.</para>
<para>Directory paths for generator output differ by priority: <filename>…/generator.early</filename> has <para>Directory paths for generator output differ by priority: <filename>…/generator.early</filename> has
priority higher than the admin configuration in <filename>/etc/</filename>, while priority higher than the admin configuration in <filename>/etc/</filename>, while
@ -96,7 +96,8 @@
<para>Generators are invoked with three arguments: paths to directories where generators can place their <para>Generators are invoked with three arguments: paths to directories where generators can place their
generated unit files or symlinks. By default those paths are runtime directories that are included in the generated unit files or symlinks. By default those paths are runtime directories that are included in the
search path of <command>systemd</command>, but a generator may be called with different paths for search path of <command>systemd</command>, but a generator may be called with different paths for
debugging purposes.</para> debugging purposes. If only one argument is provided, the generator should use the same directory as the
the three output paths.</para>
<orderedlist> <orderedlist>
<listitem> <listitem>

View File

@ -3,6 +3,7 @@
#include <stdio.h> #include <stdio.h>
#include "macro.h"
#include "main-func.h" #include "main-func.h"
int generator_open_unit_file( int generator_open_unit_file(
@ -86,11 +87,11 @@ void log_setup_generator(void);
_DEFINE_MAIN_FUNCTION( \ _DEFINE_MAIN_FUNCTION( \
({ \ ({ \
log_setup_generator(); \ log_setup_generator(); \
if (argc > 1 && argc != 4) \ if (!IN_SET(argc, 2, 4)) \
return log_error_errno(SYNTHETIC_ERRNO(EINVAL), \ return log_error_errno(SYNTHETIC_ERRNO(EINVAL), \
"This program takes zero or three arguments."); \ "This program takes one or three arguments."); \
}), \ }), \
impl(argc > 1 ? argv[1] : "/tmp", \ impl(argv[1], \
argc > 1 ? argv[2] : "/tmp", \ argv[argc == 4 ? 2 : 1], \
argc > 1 ? argv[3] : "/tmp"), \ argv[argc == 4 ? 3 : 1]), \
r < 0 ? EXIT_FAILURE : EXIT_SUCCESS) r < 0 ? EXIT_FAILURE : EXIT_SUCCESS)