diff --git a/docs/index.md b/docs/index.md index c853d8020e..c5d7f84991 100644 --- a/docs/index.md +++ b/docs/index.md @@ -67,9 +67,9 @@ Welcome to Fedora 20 (Heisenbug)! Starting Recreate Volatile Files and Directories... Starting Trigger Flushing of Journal to Persistent Storage... [ OK ] Started Recreate Volatile Files and Directories. - Starting Update UTMP about System Reboot/Shutdown... + Starting Record System Reboot/Shutdown in UTMP... [ OK ] Started Trigger Flushing of Journal to Persistent Storage. -[ OK ] Started Update UTMP about System Reboot/Shutdown. +[ OK ] Started Record System Reboot/Shutdown in UTMP. [ OK ] Reached target System Initialization. [ OK ] Reached target Timers. [ OK ] Listening on D-Bus System Message Bus Socket. diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index 2851bae31e..c11dd46143 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -257,11 +257,17 @@ StatusUnitFormat= - Takes either or as the value. If - , the system manager will use unit names in status messages, instead of the - longer and more informative descriptions set with Description=, see - systemd.unit5. - + Takes , or + as the value. If , the system manager will use unit + names in status messages (e.g. systemd-journald.service), instead of the longer + and more informative descriptions set with Description= (e.g. Journal + Logging Service). If , the system manager will use both unit names + and descriptions in status messages (e.g. systemdmd-jouranld.service - Journal Logging + Service). + + See + systemd.unit5 for + details about unit names and Description=. diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 78ba9731dd..7fafbc1d4c 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -561,20 +561,19 @@ Description= - A human readable name for the unit. This is used by - systemd (and other UIs) as the label for the unit, so this string should - identify the unit rather than describe it, despite the name. Apache2 Web - Server is a good example. Bad examples are high-performance light-weight - HTTP server (too generic) or Apache2 (too specific and - meaningless for people who do not know Apache). systemd will use this - string as a noun in status messages (Starting + A short human readable title of the unit. This may be used by + systemd (and other UIs) as a user-visible label for the unit, so this string + should identify the unit rather than describe it, despite the name. This string also shouldn't just + repeat the unit name. Apache2 Web Server is a good example. Bad examples are + high-performance light-weight HTTP server (too generic) or + Apache2 (meaningless for people who do not know Apache, duplicates the unit + name). systemd may use this string as a noun in status messages (Starting description..., Started description., Reached target description., Failed to start - description.), so it should be capitalized, and should - not be a full sentence or a phrase with a continuous verb. Bad examples include - exiting the container or updating the database once per - day.. + description.), so it should be capitalized, and should not be a + full sentence, or a phrase with a continuous verb. Bad examples include exiting the + container or updating the database once per day.. diff --git a/man/systemd.xml b/man/systemd.xml index 5f1642ee9d..cd50cd4265 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -840,9 +840,11 @@ systemd.status_unit_format= - Takes either or as the value. If - , the system manager will use unit names in status messages. If specified, - overrides the system manager configuration file option , see + Takes , or + as the value. If , the system manager will use unit + names in status messages. If , the system manager will use unit names and + description in status messages. When specified, overrides the system manager configuration file + option , see systemd-system.conf5. diff --git a/meson_options.txt b/meson_options.txt index 5048de755d..163c8df87d 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -200,7 +200,7 @@ option('default-net-naming-scheme', type : 'combo', choices : ['latest', 'v238', 'v239', 'v240'], description : 'default net.naming-scheme= value') option('status-unit-format-default', type : 'combo', - choices : ['description', 'name'], + choices : ['description', 'name', 'combined'], description : 'use unit name or description in messages by default') option('time-epoch', type : 'integer', value : '-1', description : 'time epoch for time clients') diff --git a/src/core/job.c b/src/core/job.c index afe0985ce1..eb6728ad87 100644 --- a/src/core/job.c +++ b/src/core/job.c @@ -506,52 +506,26 @@ static void job_change_type(Job *j, JobType newtype) { j->type = newtype; } -_pure_ static const char* job_get_begin_status_message_format(Unit *u, JobType t) { - const char *format; - +static const char* job_start_message_format(Unit *u, JobType t) { assert(u); + assert(IN_SET(t, JOB_START, JOB_STOP, JOB_RELOAD)); if (t == JOB_RELOAD) - return "Reloading %s."; - - assert(IN_SET(t, JOB_START, JOB_STOP)); - - format = UNIT_VTABLE(u)->status_message_formats.starting_stopping[t == JOB_STOP]; - if (format) - return format; - - /* Return generic strings */ - if (t == JOB_START) - return "Starting %s."; - else { - assert(t == JOB_STOP); - return "Stopping %s."; - } + return "Reloading %s..."; + else if (t == JOB_START) + return UNIT_VTABLE(u)->status_message_formats.starting_stopping[0] ?: "Starting %s..."; + else + return UNIT_VTABLE(u)->status_message_formats.starting_stopping[1] ?: "Stopping %s..."; } -static void job_print_begin_status_message(Unit *u, JobType t) { - const char *format; - - assert(u); - - /* Reload status messages have traditionally not been printed to console. */ - if (!IN_SET(t, JOB_START, JOB_STOP)) - return; - - format = job_get_begin_status_message_format(u, t); - - DISABLE_WARNING_FORMAT_NONLITERAL; - unit_status_printf(u, STATUS_TYPE_NORMAL, "", format); - REENABLE_WARNING; -} - -static void job_log_begin_status_message(Unit *u, uint32_t job_id, JobType t) { - const char *format, *mid; - char buf[LINE_MAX]; +static void job_emit_start_message(Unit *u, uint32_t job_id, JobType t) { + _cleanup_free_ char *free_ident = NULL; + const char *ident, *format; assert(u); assert(t >= 0); assert(t < _JOB_TYPE_MAX); + assert(u->id); /* We better don't try to run a unit that doesn't even have an id. */ if (!IN_SET(t, JOB_START, JOB_STOP, JOB_RELOAD)) return; @@ -559,42 +533,214 @@ static void job_log_begin_status_message(Unit *u, uint32_t job_id, JobType t) { if (!unit_log_level_test(u, LOG_INFO)) return; - if (log_on_console()) /* Skip this if it would only go on the console anyway */ - return; + format = job_start_message_format(u, t); + ident = unit_status_string(u, &free_ident); - /* We log status messages for all units and all operations. */ + bool do_console = t != JOB_RELOAD; + bool console_only = do_console && log_on_console(); /* Reload status messages have traditionally + * not been printed to the console. */ - format = job_get_begin_status_message_format(u, t); + /* Print to the log first. */ + if (!console_only) { /* Skip this if it would only go on the console anyway */ - DISABLE_WARNING_FORMAT_NONLITERAL; - (void) snprintf(buf, sizeof buf, format, unit_status_string(u)); - REENABLE_WARNING; + const char *mid = + t == JOB_START ? "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTING_STR : + t == JOB_STOP ? "MESSAGE_ID=" SD_MESSAGE_UNIT_STOPPING_STR : + "MESSAGE_ID=" SD_MESSAGE_UNIT_RELOADING_STR; + const char *msg_fmt = strjoina("MESSAGE=", format); - mid = t == JOB_START ? "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTING_STR : - t == JOB_STOP ? "MESSAGE_ID=" SD_MESSAGE_UNIT_STOPPING_STR : - "MESSAGE_ID=" SD_MESSAGE_UNIT_RELOADING_STR; + /* Note that we deliberately use LOG_MESSAGE() instead of LOG_UNIT_MESSAGE() here, since this + * is supposed to mimic closely what is written to screen using the status output, which is + * supposed to be high level friendly output. */ - /* Note that we deliberately use LOG_MESSAGE() instead of - * LOG_UNIT_MESSAGE() here, since this is supposed to mimic - * closely what is written to screen using the status output, - * which is supposed the highest level, friendliest output - * possible, which means we should avoid the low-level unit - * name. */ - log_unit_struct(u, LOG_INFO, - LOG_MESSAGE("%s", buf), - "JOB_ID=%" PRIu32, job_id, - "JOB_TYPE=%s", job_type_to_string(t), - LOG_UNIT_INVOCATION_ID(u), - mid); + DISABLE_WARNING_FORMAT_NONLITERAL; + log_unit_struct(u, LOG_INFO, + msg_fmt, ident, + "JOB_ID=%" PRIu32, job_id, + "JOB_TYPE=%s", job_type_to_string(t), + LOG_UNIT_INVOCATION_ID(u), + mid); + REENABLE_WARNING; + } + + /* Log to the console second. */ + if (do_console) { + DISABLE_WARNING_FORMAT_NONLITERAL; + unit_status_printf(u, STATUS_TYPE_NORMAL, "", format, ident); + REENABLE_WARNING; + } } -static void job_emit_begin_status_message(Unit *u, uint32_t job_id, JobType t) { +static const char* job_done_message_format(Unit *u, JobType t, JobResult result) { + static const char* const generic_finished_start_job[_JOB_RESULT_MAX] = { + [JOB_DONE] = "Started %s.", + [JOB_TIMEOUT] = "Timed out starting %s.", + [JOB_FAILED] = "Failed to start %s.", + [JOB_DEPENDENCY] = "Dependency failed for %s.", + [JOB_ASSERT] = "Assertion failed for %s.", + [JOB_UNSUPPORTED] = "Starting of %s unsupported.", + [JOB_COLLECTED] = "Unnecessary job was removed for %s.", + [JOB_ONCE] = "Unit %s has been started before and cannot be started again.", + }; + static const char* const generic_finished_stop_job[_JOB_RESULT_MAX] = { + [JOB_DONE] = "Stopped %s.", + [JOB_FAILED] = "Stopped %s with error.", + [JOB_TIMEOUT] = "Timed out stopping %s.", + }; + static const char* const generic_finished_reload_job[_JOB_RESULT_MAX] = { + [JOB_DONE] = "Reloaded %s.", + [JOB_FAILED] = "Reload failed for %s.", + [JOB_TIMEOUT] = "Timed out reloading %s.", + }; + /* When verify-active detects the unit is inactive, report it. + * Most likely a DEPEND warning from a requisiting unit will + * occur next and it's nice to see what was requisited. */ + static const char* const generic_finished_verify_active_job[_JOB_RESULT_MAX] = { + [JOB_SKIPPED] = "%s is inactive.", + }; + const char *format; + assert(u); assert(t >= 0); assert(t < _JOB_TYPE_MAX); - job_log_begin_status_message(u, job_id, t); - job_print_begin_status_message(u, t); + /* Show condition check message if the job did not actually do anything due to failed condition. */ + if (t == JOB_START && result == JOB_DONE && !u->condition_result) + return "Condition check resulted in %s being skipped."; + + if (IN_SET(t, JOB_START, JOB_STOP, JOB_RESTART)) { + const UnitStatusMessageFormats *formats = &UNIT_VTABLE(u)->status_message_formats; + if (formats->finished_job) { + format = formats->finished_job(u, t, result); + if (format) + return format; + } + + format = (t == JOB_START ? formats->finished_start_job : formats->finished_stop_job)[result]; + if (format) + return format; + } + + /* Return generic strings */ + switch (t) { + case JOB_START: + return generic_finished_start_job[result]; + case JOB_STOP: + case JOB_RESTART: + return generic_finished_stop_job[result]; + case JOB_RELOAD: + return generic_finished_reload_job[result]; + case JOB_VERIFY_ACTIVE: + return generic_finished_verify_active_job[result]; + default: + return NULL; + } +} + +static const struct { + int log_level; + const char *color, *word; +} job_done_messages[_JOB_RESULT_MAX] = { + [JOB_DONE] = { LOG_INFO, ANSI_OK_COLOR, " OK " }, + [JOB_CANCELED] = { LOG_INFO, }, + [JOB_TIMEOUT] = { LOG_ERR, ANSI_HIGHLIGHT_RED, " TIME " }, + [JOB_FAILED] = { LOG_ERR, ANSI_HIGHLIGHT_RED, "FAILED" }, + [JOB_DEPENDENCY] = { LOG_WARNING, ANSI_HIGHLIGHT_YELLOW, "DEPEND" }, + [JOB_SKIPPED] = { LOG_NOTICE, ANSI_HIGHLIGHT, " INFO " }, + [JOB_INVALID] = { LOG_INFO, }, + [JOB_ASSERT] = { LOG_WARNING, ANSI_HIGHLIGHT_YELLOW, "ASSERT" }, + [JOB_UNSUPPORTED] = { LOG_WARNING, ANSI_HIGHLIGHT_YELLOW, "UNSUPP" }, + [JOB_COLLECTED] = { LOG_INFO, }, + [JOB_ONCE] = { LOG_ERR, ANSI_HIGHLIGHT_RED, " ONCE " }, +}; + +static const char* job_done_mid(JobType type, JobResult result) { + switch (type) { + case JOB_START: + if (result == JOB_DONE) + return "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTED_STR; + else + return "MESSAGE_ID=" SD_MESSAGE_UNIT_FAILED_STR; + + case JOB_RELOAD: + return "MESSAGE_ID=" SD_MESSAGE_UNIT_RELOADED_STR; + + case JOB_STOP: + case JOB_RESTART: + return "MESSAGE_ID=" SD_MESSAGE_UNIT_STOPPED_STR; + + default: + return NULL; + } +} + +static void job_emit_done_message(Unit *u, uint32_t job_id, JobType t, JobResult result) { + _cleanup_free_ char *free_ident = NULL; + const char *ident, *format; + + assert(u); + assert(t >= 0); + assert(t < _JOB_TYPE_MAX); + + if (!unit_log_level_test(u, job_done_messages[result].log_level)) + return; + + format = job_done_message_format(u, t, result); + if (!format) + return; + + ident = unit_status_string(u, &free_ident); + + const char *status = job_done_messages[result].word; + bool do_console = t != JOB_RELOAD && status; + bool console_only = do_console && log_on_console(); + + if (t == JOB_START && result == JOB_DONE && !u->condition_result) { + /* No message on the console if the job did not actually do anything due to failed condition. */ + if (console_only) + return; + else + do_console = false; + } + + if (!console_only) { /* Skip printing if output goes to the console, and job_print_status_message() + * will actually print something to the console. */ + + const char *mid = job_done_mid(t, result); /* mid may be NULL. log_unit_struct() will ignore it. */ + const char *msg_fmt = strjoina("MESSAGE=", format); + + DISABLE_WARNING_FORMAT_NONLITERAL; + log_unit_struct(u, job_done_messages[result].log_level, + msg_fmt, ident, + "JOB_ID=%" PRIu32, job_id, + "JOB_TYPE=%s", job_type_to_string(t), + "JOB_RESULT=%s", job_result_to_string(result), + LOG_UNIT_INVOCATION_ID(u), + mid); + REENABLE_WARNING; + } + + if (do_console) { + if (log_get_show_color()) + status = strjoina(job_done_messages[result].color, + status, + ANSI_NORMAL); + + DISABLE_WARNING_FORMAT_NONLITERAL; + unit_status_printf(u, + result == JOB_DONE ? STATUS_TYPE_NORMAL : STATUS_TYPE_NOTICE, + status, format, ident); + REENABLE_WARNING; + + if (t == JOB_START && result == JOB_FAILED) { + _cleanup_free_ char *quoted = NULL; + + quoted = shell_maybe_quote(u->id, 0); + if (quoted) + manager_status_printf(u->manager, STATUS_TYPE_NORMAL, NULL, + "See 'systemctl status %s' for details.", quoted); + } + } } static int job_perform_on_unit(Job **j) { @@ -643,7 +789,7 @@ static int job_perform_on_unit(Job **j) { * 'active') we'll possibly skip the "Starting..." message. */ *j = manager_get_job(m, id); if (*j && r > 0) - job_emit_begin_status_message(u, id, t); + job_emit_start_message(u, id, t); return r; } @@ -732,224 +878,6 @@ int job_run_and_invalidate(Job *j) { return r; } -_pure_ static const char *job_get_done_status_message_format(Unit *u, JobType t, JobResult result) { - - static const char *const generic_finished_start_job[_JOB_RESULT_MAX] = { - [JOB_DONE] = "Started %s.", - [JOB_TIMEOUT] = "Timed out starting %s.", - [JOB_FAILED] = "Failed to start %s.", - [JOB_DEPENDENCY] = "Dependency failed for %s.", - [JOB_ASSERT] = "Assertion failed for %s.", - [JOB_UNSUPPORTED] = "Starting of %s not supported.", - [JOB_COLLECTED] = "Unnecessary job for %s was removed.", - [JOB_ONCE] = "Unit %s has been started before and cannot be started again." - }; - static const char *const generic_finished_stop_job[_JOB_RESULT_MAX] = { - [JOB_DONE] = "Stopped %s.", - [JOB_FAILED] = "Stopped (with error) %s.", - [JOB_TIMEOUT] = "Timed out stopping %s.", - }; - static const char *const generic_finished_reload_job[_JOB_RESULT_MAX] = { - [JOB_DONE] = "Reloaded %s.", - [JOB_FAILED] = "Reload failed for %s.", - [JOB_TIMEOUT] = "Timed out reloading %s.", - }; - /* When verify-active detects the unit is inactive, report it. - * Most likely a DEPEND warning from a requisiting unit will - * occur next and it's nice to see what was requisited. */ - static const char *const generic_finished_verify_active_job[_JOB_RESULT_MAX] = { - [JOB_SKIPPED] = "%s is not active.", - }; - - const char *format; - - assert(u); - assert(t >= 0); - assert(t < _JOB_TYPE_MAX); - - if (IN_SET(t, JOB_START, JOB_STOP, JOB_RESTART)) { - const UnitStatusMessageFormats *formats = &UNIT_VTABLE(u)->status_message_formats; - if (formats->finished_job) { - format = formats->finished_job(u, t, result); - if (format) - return format; - } - format = t == JOB_START ? - formats->finished_start_job[result] : - formats->finished_stop_job[result]; - if (format) - return format; - } - - /* Return generic strings */ - if (t == JOB_START) - return generic_finished_start_job[result]; - else if (IN_SET(t, JOB_STOP, JOB_RESTART)) - return generic_finished_stop_job[result]; - else if (t == JOB_RELOAD) - return generic_finished_reload_job[result]; - else if (t == JOB_VERIFY_ACTIVE) - return generic_finished_verify_active_job[result]; - - return NULL; -} - -static const struct { - const char *color, *word; -} job_print_done_status_messages[_JOB_RESULT_MAX] = { - [JOB_DONE] = { ANSI_OK_COLOR, " OK " }, - [JOB_TIMEOUT] = { ANSI_HIGHLIGHT_RED, " TIME " }, - [JOB_FAILED] = { ANSI_HIGHLIGHT_RED, "FAILED" }, - [JOB_DEPENDENCY] = { ANSI_HIGHLIGHT_YELLOW, "DEPEND" }, - [JOB_SKIPPED] = { ANSI_HIGHLIGHT, " INFO " }, - [JOB_ASSERT] = { ANSI_HIGHLIGHT_YELLOW, "ASSERT" }, - [JOB_UNSUPPORTED] = { ANSI_HIGHLIGHT_YELLOW, "UNSUPP" }, - /* JOB_COLLECTED */ - [JOB_ONCE] = { ANSI_HIGHLIGHT_RED, " ONCE " }, -}; - -static void job_print_done_status_message(Unit *u, JobType t, JobResult result) { - const char *format; - const char *status; - - assert(u); - assert(t >= 0); - assert(t < _JOB_TYPE_MAX); - - /* Reload status messages have traditionally not been printed to console. */ - if (t == JOB_RELOAD) - return; - - /* No message if the job did not actually do anything due to failed condition. */ - if (t == JOB_START && result == JOB_DONE && !u->condition_result) - return; - - if (!job_print_done_status_messages[result].word) - return; - - format = job_get_done_status_message_format(u, t, result); - if (!format) - return; - - if (log_get_show_color()) - status = strjoina(job_print_done_status_messages[result].color, - job_print_done_status_messages[result].word, - ANSI_NORMAL); - else - status = job_print_done_status_messages[result].word; - - DISABLE_WARNING_FORMAT_NONLITERAL; - unit_status_printf(u, - result == JOB_DONE ? STATUS_TYPE_NORMAL : STATUS_TYPE_NOTICE, - status, format); - REENABLE_WARNING; - - if (t == JOB_START && result == JOB_FAILED) { - _cleanup_free_ char *quoted = NULL; - - quoted = shell_maybe_quote(u->id, 0); - manager_status_printf(u->manager, STATUS_TYPE_NORMAL, NULL, "See 'systemctl status %s' for details.", strna(quoted)); - } -} - -static void job_log_done_status_message(Unit *u, uint32_t job_id, JobType t, JobResult result) { - const char *format, *mid; - char buf[LINE_MAX]; - static const int job_result_log_level[_JOB_RESULT_MAX] = { - [JOB_DONE] = LOG_INFO, - [JOB_CANCELED] = LOG_INFO, - [JOB_TIMEOUT] = LOG_ERR, - [JOB_FAILED] = LOG_ERR, - [JOB_DEPENDENCY] = LOG_WARNING, - [JOB_SKIPPED] = LOG_NOTICE, - [JOB_INVALID] = LOG_INFO, - [JOB_ASSERT] = LOG_WARNING, - [JOB_UNSUPPORTED] = LOG_WARNING, - [JOB_COLLECTED] = LOG_INFO, - [JOB_ONCE] = LOG_ERR, - }; - - assert(u); - assert(t >= 0); - assert(t < _JOB_TYPE_MAX); - - /* Skip printing if output goes to the console, and job_print_status_message() - will actually print something to the console. */ - if (log_on_console() && job_print_done_status_messages[result].word) - return; - - /* Show condition check message if the job did not actually do anything due to failed condition. */ - if (t == JOB_START && result == JOB_DONE && !u->condition_result) { - log_unit_struct(u, LOG_INFO, - "MESSAGE=Condition check resulted in %s being skipped.", unit_status_string(u), - "JOB_ID=%" PRIu32, job_id, - "JOB_TYPE=%s", job_type_to_string(t), - "JOB_RESULT=%s", job_result_to_string(result), - LOG_UNIT_INVOCATION_ID(u), - "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTED_STR); - - return; - } - - if (!unit_log_level_test(u, job_result_log_level[result])) - return; - - format = job_get_done_status_message_format(u, t, result); - if (!format) - return; - - /* The description might be longer than the buffer, but that's OK, - * we'll just truncate it here. Note that we use snprintf() rather than - * xsprintf() on purpose here: we are fine with truncation and don't - * consider that an error. */ - DISABLE_WARNING_FORMAT_NONLITERAL; - (void) snprintf(buf, sizeof(buf), format, unit_status_string(u)); - REENABLE_WARNING; - - switch (t) { - - case JOB_START: - if (result == JOB_DONE) - mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_STARTED_STR; - else - mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_FAILED_STR; - break; - - case JOB_RELOAD: - mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_RELOADED_STR; - break; - - case JOB_STOP: - case JOB_RESTART: - mid = "MESSAGE_ID=" SD_MESSAGE_UNIT_STOPPED_STR; - break; - - default: - log_unit_struct(u, job_result_log_level[result], - LOG_MESSAGE("%s", buf), - "JOB_ID=%" PRIu32, job_id, - "JOB_TYPE=%s", job_type_to_string(t), - "JOB_RESULT=%s", job_result_to_string(result), - LOG_UNIT_INVOCATION_ID(u)); - return; - } - - log_unit_struct(u, job_result_log_level[result], - LOG_MESSAGE("%s", buf), - "JOB_ID=%" PRIu32, job_id, - "JOB_TYPE=%s", job_type_to_string(t), - "JOB_RESULT=%s", job_result_to_string(result), - LOG_UNIT_INVOCATION_ID(u), - mid); -} - -static void job_emit_done_status_message(Unit *u, uint32_t job_id, JobType t, JobResult result) { - assert(u); - - job_log_done_status_message(u, job_id, t, result); - job_print_done_status_message(u, t, result); -} - static void job_fail_dependencies(Unit *u, UnitDependencyAtom match_atom) { Unit *other; @@ -985,7 +913,7 @@ int job_finish_and_invalidate(Job *j, JobResult result, bool recursive, bool alr /* If this job did nothing to the respective unit we don't log the status message */ if (!already) - job_emit_done_status_message(u, j->id, t, result); + job_emit_done_message(u, j->id, t, result); /* Patch restart jobs so that they become normal start jobs */ if (result == JOB_DONE && t == JOB_RESTART) { diff --git a/src/core/main.c b/src/core/main.c index 906c1482d7..da6c50a1c4 100644 --- a/src/core/main.c +++ b/src/core/main.c @@ -2219,7 +2219,7 @@ static int do_queue_default_job( } else log_info("Queued %s job for default target %s.", job_type_to_string(job->type), - unit_status_string(job->unit)); + unit_status_string(job->unit, NULL)); m->default_unit_job_id = job->id; diff --git a/src/core/manager.c b/src/core/manager.c index f8676be422..606ee39c38 100644 --- a/src/core/manager.c +++ b/src/core/manager.c @@ -240,11 +240,18 @@ static void manager_print_jobs_in_progress(Manager *m) { if (job_get_timeout(j, &x) > 0) format_timespan(limit, sizeof(limit), x - j->begin_usec, 1*USEC_PER_SEC); + /* We want to use enough information for the user to identify previous lines talking about the same + * unit, but keep the message as short as possible. So if 'Starting foo.service' or 'Starting + * foo.service (Description)' were used, 'foo.service' is enough here. On the other hand, if we used + * 'Starting Description' before, then we shall also use 'Description' here. So we pass NULL as the + * second argument to unit_status_string(). */ + const char *ident = unit_status_string(j->unit, NULL); + manager_status_printf(m, STATUS_TYPE_EPHEMERAL, cylon, "%sA %s job is running for %s (%s / %s)", strempty(job_of_n), job_type_to_string(j->type), - unit_status_string(j->unit), + ident, time, limit); } diff --git a/src/core/service.c b/src/core/service.c index 0b7555c856..8517d5441c 100644 --- a/src/core/service.c +++ b/src/core/service.c @@ -4433,12 +4433,10 @@ static int service_can_clean(Unit *u, ExecCleanMask *ret) { } static const char *service_finished_job(Unit *u, JobType t, JobResult result) { - if (t == JOB_START && result == JOB_DONE) { - Service *s = SERVICE(u); - - if (s->type == SERVICE_ONESHOT) - return "Finished %s."; - } + if (t == JOB_START && + result == JOB_DONE && + SERVICE(u)->type == SERVICE_ONESHOT) + return "Finished %s."; /* Fall back to generic */ return NULL; @@ -4597,10 +4595,6 @@ const UnitVTable service_vtable = { .exit_status = service_exit_status, .status_message_formats = { - .starting_stopping = { - [0] = "Starting %s...", - [1] = "Stopping %s...", - }, .finished_start_job = { [JOB_FAILED] = "Failed to start %s.", }, diff --git a/src/core/show-status.c b/src/core/show-status.c index a74423cb85..df25429938 100644 --- a/src/core/show-status.c +++ b/src/core/show-status.c @@ -123,6 +123,7 @@ int status_printf(const char *status, ShowStatusFlags flags, const char *format, static const char* const status_unit_format_table[_STATUS_UNIT_FORMAT_MAX] = { [STATUS_UNIT_FORMAT_NAME] = "name", [STATUS_UNIT_FORMAT_DESCRIPTION] = "description", + [STATUS_UNIT_FORMAT_COMBINED] = "combined", }; DEFINE_STRING_TABLE_LOOKUP(status_unit_format, StatusUnitFormat); diff --git a/src/core/show-status.h b/src/core/show-status.h index dfcf5f4103..f441223dff 100644 --- a/src/core/show-status.h +++ b/src/core/show-status.h @@ -25,6 +25,7 @@ typedef enum ShowStatusFlags { typedef enum StatusUnitFormat { STATUS_UNIT_FORMAT_NAME, STATUS_UNIT_FORMAT_DESCRIPTION, + STATUS_UNIT_FORMAT_COMBINED, _STATUS_UNIT_FORMAT_MAX, _STATUS_UNIT_FORMAT_INVALID = -EINVAL, } StatusUnitFormat; diff --git a/src/core/slice.c b/src/core/slice.c index 595f704a17..2e43c00119 100644 --- a/src/core/slice.c +++ b/src/core/slice.c @@ -180,6 +180,14 @@ static int slice_load(Unit *u) { if (r < 0) return r; + if (!u->description) { + _cleanup_free_ char *tmp = NULL; + + r = unit_name_to_path(u->id, &tmp); + if (r >= 0) /* Failure is ignored… */ + u->description = strjoin("Slice ", tmp); + } + return slice_verify(s); } diff --git a/src/core/socket.c b/src/core/socket.c index d93186ddbd..8144780bf8 100644 --- a/src/core/socket.c +++ b/src/core/socket.c @@ -3543,10 +3543,6 @@ const UnitVTable socket_vtable = { .bus_commit_properties = bus_socket_commit_properties, .status_message_formats = { - /*.starting_stopping = { - [0] = "Starting socket %s...", - [1] = "Stopping socket %s...", - },*/ .finished_start_job = { [JOB_DONE] = "Listening on %s.", [JOB_FAILED] = "Failed to listen on %s.", diff --git a/src/core/transaction.c b/src/core/transaction.c index 51232e4ab1..ebe5f1910d 100644 --- a/src/core/transaction.c +++ b/src/core/transaction.c @@ -419,7 +419,8 @@ static int transaction_verify_order_one(Transaction *tr, Job *j, Job *from, unsi unit_status_printf(delete->unit, STATUS_TYPE_NOTICE, status, - "Ordering cycle found, skipping %s"); + "Ordering cycle found, skipping %s", + unit_status_string(delete->unit, NULL)); transaction_delete_unit(tr, delete->unit); return -EAGAIN; } diff --git a/src/core/unit.c b/src/core/unit.c index b203f16e9b..57e4acff3a 100644 --- a/src/core/unit.c +++ b/src/core/unit.c @@ -1331,7 +1331,7 @@ int unit_add_exec_dependencies(Unit *u, ExecContext *c) { return 0; } -const char *unit_description(Unit *u) { +const char* unit_description(Unit *u) { assert(u); if (u->description) @@ -1340,13 +1340,30 @@ const char *unit_description(Unit *u) { return strna(u->id); } -const char *unit_status_string(Unit *u) { +const char* unit_status_string(Unit *u, char **combined) { assert(u); + assert(u->id); - if (u->manager->status_unit_format == STATUS_UNIT_FORMAT_NAME && u->id) + /* Return u->id, u->description, or "{u->id} - {u->description}". + * Versions with u->description are only used if it is set. + * The last option is used if configured and the caller provided 'combined' pointer. */ + + if (!u->description || + streq(u->description, u->id) || + u->manager->status_unit_format == STATUS_UNIT_FORMAT_NAME || + (u->manager->status_unit_format == STATUS_UNIT_FORMAT_COMBINED && !combined)) return u->id; - return unit_description(u); + if (u->description && u->manager->status_unit_format == STATUS_UNIT_FORMAT_COMBINED && combined) { + char *t = strjoin(u->id, " - ", u->description); + if (t) { + *combined = t; + return t; + } else + log_oom(); + } + + return u->description; } /* Common implementation for multiple backends */ @@ -1730,15 +1747,16 @@ static bool unit_test_assert(Unit *u) { return u->assert_result; } -void unit_status_printf(Unit *u, StatusType status_type, const char *status, const char *unit_status_msg_format) { - const char *d; - - d = unit_status_string(u); - if (log_get_show_color()) - d = strjoina(ANSI_HIGHLIGHT, d, ANSI_NORMAL); +void unit_status_printf(Unit *u, StatusType status_type, const char *status, const char *format, const char *ident) { + if (log_get_show_color()) { + if (u->manager->status_unit_format == STATUS_UNIT_FORMAT_COMBINED && strchr(ident, ' ')) + ident = strjoina(ANSI_HIGHLIGHT, u->id, ANSI_NORMAL, " - ", u->description); + else + ident = strjoina(ANSI_HIGHLIGHT, ident, ANSI_NORMAL); + } DISABLE_WARNING_FORMAT_NONLITERAL; - manager_status_printf(u->manager, status_type, status, unit_status_msg_format, d); + manager_status_printf(u->manager, status_type, status, format, ident); REENABLE_WARNING; } diff --git a/src/core/unit.h b/src/core/unit.h index 3b302e7e20..759104ffa7 100644 --- a/src/core/unit.h +++ b/src/core/unit.h @@ -765,7 +765,7 @@ int unit_set_slice(Unit *u, Unit *slice, UnitDependencyMask mask); int unit_set_default_slice(Unit *u); const char *unit_description(Unit *u) _pure_; -const char *unit_status_string(Unit *u) _pure_; +const char *unit_status_string(Unit *u, char **combined); bool unit_has_name(const Unit *u, const char *name); @@ -820,7 +820,7 @@ int unit_add_blockdev_dependency(Unit *u, const char *what, UnitDependencyMask m int unit_coldplug(Unit *u); void unit_catchup(Unit *u); -void unit_status_printf(Unit *u, StatusType status_type, const char *status, const char *unit_status_msg_format) _printf_(4, 0); +void unit_status_printf(Unit *u, StatusType status_type, const char *status, const char *format, const char *ident) _printf_(4, 0); bool unit_need_daemon_reload(Unit *u); diff --git a/src/login/logind-session.c b/src/login/logind-session.c index 6a3dd860db..3f09750ec9 100644 --- a/src/login/logind-session.c +++ b/src/login/logind-session.c @@ -655,7 +655,7 @@ static int session_start_scope(Session *s, sd_bus_message *properties, sd_bus_er if (!scope) return log_oom(); - description = strjoina("Session ", s->id, " of user ", s->user->user_record->user_name); + description = strjoina("Session ", s->id, " of User ", s->user->user_record->user_name); r = manager_start_scope( s->manager, diff --git a/units/bluetooth.target b/units/bluetooth.target index 8333c2332f..ab23c850c6 100644 --- a/units/bluetooth.target +++ b/units/bluetooth.target @@ -8,6 +8,6 @@ # (at your option) any later version. [Unit] -Description=Bluetooth +Description=Bluetooth Support Documentation=man:systemd.special(7) StopWhenUnneeded=yes diff --git a/units/exit.target b/units/exit.target index d7a1472a2b..f8a22e52c6 100644 --- a/units/exit.target +++ b/units/exit.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Exit the container +Description=Exit the Container Documentation=man:systemd.special(7) DefaultDependencies=no Requires=systemd-exit.service diff --git a/units/final.target b/units/final.target index 34f6069dd1..4c86ca7935 100644 --- a/units/final.target +++ b/units/final.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Final Step +Description=Late Boot Services Documentation=man:systemd.special(7) DefaultDependencies=no RefuseManualStart=yes diff --git a/units/getty-pre.target b/units/getty-pre.target index 5cf0875fae..663011de1d 100644 --- a/units/getty-pre.target +++ b/units/getty-pre.target @@ -8,6 +8,6 @@ # (at your option) any later version. [Unit] -Description=Login Prompts (Pre) +Description=Preparation for Logins Documentation=man:systemd.special(7) man:systemd-getty-generator(8) Documentation=http://0pointer.de/blog/projects/serial-console.html diff --git a/units/halt.target b/units/halt.target index b06758bf95..bfa5f23e1d 100644 --- a/units/halt.target +++ b/units/halt.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Halt +Description=System Halt Documentation=man:systemd.special(7) DefaultDependencies=no Requires=systemd-halt.service diff --git a/units/hibernate.target b/units/hibernate.target index 9ec6f2a6b1..838c5a3e9b 100644 --- a/units/hibernate.target +++ b/units/hibernate.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Hibernate +Description=System Hibernation Documentation=man:systemd.special(7) DefaultDependencies=no Requires=systemd-hibernate.service diff --git a/units/kmod-static-nodes.service.in b/units/kmod-static-nodes.service.in index fd5e6d7ca6..777e82d16b 100644 --- a/units/kmod-static-nodes.service.in +++ b/units/kmod-static-nodes.service.in @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Create list of static device nodes for the current kernel +Description=Create List of Static Device Nodes DefaultDependencies=no Before=sysinit.target systemd-tmpfiles-setup-dev.service ConditionCapability=CAP_SYS_MODULE diff --git a/units/local-fs-pre.target b/units/local-fs-pre.target index bffa7e95dd..8e0f4b8ffb 100644 --- a/units/local-fs-pre.target +++ b/units/local-fs-pre.target @@ -8,6 +8,6 @@ # (at your option) any later version. [Unit] -Description=Local File Systems (Pre) +Description=Preparation for Local File Systems Documentation=man:systemd.special(7) RefuseManualStart=yes diff --git a/units/network-pre.target b/units/network-pre.target index 70279dacdb..f92449b50b 100644 --- a/units/network-pre.target +++ b/units/network-pre.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Network (Pre) +Description=Preparation for Network Documentation=man:systemd.special(7) Documentation=https://www.freedesktop.org/wiki/Software/systemd/NetworkTarget RefuseManualStart=yes diff --git a/units/paths.target b/units/paths.target index 1bec148bee..fb8dc64320 100644 --- a/units/paths.target +++ b/units/paths.target @@ -8,5 +8,5 @@ # (at your option) any later version. [Unit] -Description=Paths +Description=Path Units Documentation=man:systemd.special(7) diff --git a/units/poweroff.target b/units/poweroff.target index e97f058fdc..c17c123dfe 100644 --- a/units/poweroff.target +++ b/units/poweroff.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Power-Off +Description=System Power Off Documentation=man:systemd.special(7) DefaultDependencies=no Requires=systemd-poweroff.service diff --git a/units/printer.target b/units/printer.target index c695669c5c..043bfbd61e 100644 --- a/units/printer.target +++ b/units/printer.target @@ -8,6 +8,6 @@ # (at your option) any later version. [Unit] -Description=Printer +Description=Printer Support Documentation=man:systemd.special(7) StopWhenUnneeded=yes diff --git a/units/reboot.target b/units/reboot.target index a900c90dcf..5ad941935e 100644 --- a/units/reboot.target +++ b/units/reboot.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Reboot +Description=System Reboot Documentation=man:systemd.special(7) DefaultDependencies=no Requires=systemd-reboot.service diff --git a/units/remote-fs-pre.target b/units/remote-fs-pre.target index bba5e0ce7c..1ede280eff 100644 --- a/units/remote-fs-pre.target +++ b/units/remote-fs-pre.target @@ -8,6 +8,6 @@ # (at your option) any later version. [Unit] -Description=Remote File Systems (Pre) +Description=Preparation for Remote File Systems Documentation=man:systemd.special(7) RefuseManualStart=yes diff --git a/units/shutdown.target b/units/shutdown.target index 582ae6ba27..8b3c0b6989 100644 --- a/units/shutdown.target +++ b/units/shutdown.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Shutdown +Description=System Shutdown Documentation=man:systemd.special(7) DefaultDependencies=no RefuseManualStart=yes diff --git a/units/slices.target b/units/slices.target index 4517e35fc5..72701bd2a8 100644 --- a/units/slices.target +++ b/units/slices.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Slices +Description=Slice Units Documentation=man:systemd.special(7) Wants=-.slice system.slice After=-.slice system.slice diff --git a/units/sockets.target b/units/sockets.target index c6e20d7760..e53d1ebb7d 100644 --- a/units/sockets.target +++ b/units/sockets.target @@ -8,5 +8,5 @@ # (at your option) any later version. [Unit] -Description=Sockets +Description=Socket Units Documentation=man:systemd.special(7) diff --git a/units/swap.target b/units/swap.target index bcdd98815b..1f2160765a 100644 --- a/units/swap.target +++ b/units/swap.target @@ -8,5 +8,5 @@ # (at your option) any later version. [Unit] -Description=Swap +Description=Swaps Documentation=man:systemd.special(7) diff --git a/units/systemd-halt.service b/units/systemd-halt.service index 37bfe285c0..3ce976f539 100644 --- a/units/systemd-halt.service +++ b/units/systemd-halt.service @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Halt +Description=System Halt Documentation=man:systemd-halt.service(8) DefaultDependencies=no Requires=shutdown.target umount.target final.target diff --git a/units/systemd-networkd.service.in b/units/systemd-networkd.service.in index 9a40d2afa5..ffa45ba049 100644 --- a/units/systemd-networkd.service.in +++ b/units/systemd-networkd.service.in @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Network Service +Description=Network Configuration Documentation=man:systemd-networkd.service(8) ConditionCapability=CAP_NET_ADMIN DefaultDependencies=no diff --git a/units/systemd-poweroff.service b/units/systemd-poweroff.service index d95c618e79..254188d682 100644 --- a/units/systemd-poweroff.service +++ b/units/systemd-poweroff.service @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Power-Off +Description=System Power Off Documentation=man:systemd-poweroff.service(8) DefaultDependencies=no Requires=shutdown.target umount.target final.target diff --git a/units/systemd-reboot.service b/units/systemd-reboot.service index 5c7ade7d02..79176ada31 100644 --- a/units/systemd-reboot.service +++ b/units/systemd-reboot.service @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Reboot +Description=System Reboot Documentation=man:systemd-reboot.service(8) DefaultDependencies=no Requires=shutdown.target umount.target final.target diff --git a/units/systemd-suspend.service.in b/units/systemd-suspend.service.in index 1ae32af5f7..2515575e10 100644 --- a/units/systemd-suspend.service.in +++ b/units/systemd-suspend.service.in @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Suspend +Description=System Suspend Documentation=man:systemd-suspend.service(8) DefaultDependencies=no Requires=sleep.target diff --git a/units/systemd-update-utmp-runlevel.service.in b/units/systemd-update-utmp-runlevel.service.in index d94b22253e..11177dc621 100644 --- a/units/systemd-update-utmp-runlevel.service.in +++ b/units/systemd-update-utmp-runlevel.service.in @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Update UTMP about System Runlevel Changes +Description=Record Runlevel Change in UTMP Documentation=man:systemd-update-utmp-runlevel.service(8) man:utmp(5) DefaultDependencies=no RequiresMountsFor=/var/log/wtmp diff --git a/units/systemd-update-utmp.service.in b/units/systemd-update-utmp.service.in index 89bfd63621..cedefa8e08 100644 --- a/units/systemd-update-utmp.service.in +++ b/units/systemd-update-utmp.service.in @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Update UTMP about System Boot/Shutdown +Description=Record System Boot/Shutdown in UTMP Documentation=man:systemd-update-utmp.service(8) man:utmp(5) DefaultDependencies=no RequiresMountsFor=/var/log/wtmp diff --git a/units/timers.target b/units/timers.target index 99f82e3b80..2e626be753 100644 --- a/units/timers.target +++ b/units/timers.target @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Timers +Description=Timer Units Documentation=man:systemd.special(7) DefaultDependencies=no diff --git a/units/tmp.mount b/units/tmp.mount index a8e5851632..516bd1621c 100644 --- a/units/tmp.mount +++ b/units/tmp.mount @@ -8,7 +8,7 @@ # (at your option) any later version. [Unit] -Description=Temporary Directory (/tmp) +Description=Temporary Directory /tmp Documentation=https://systemd.io/TEMPORARY_DIRECTORIES Documentation=man:file-hierarchy(7) Documentation=https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems