Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

status: Introduce tool to quickly check if we are booted as default #3134

Merged
merged 3 commits into from
Jan 8, 2024
Merged

status: Introduce tool to quickly check if we are booted as default #3134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1397ee2
status: Introduce tool to quickly check if we are booted as default
ericcurtin Jan 5, 2024
c13aef9
man: Add ostree admin status man page CLI options.
ericcurtin Jan 5, 2024
46bae54
status: Fix --skip-signatures description
ericcurtin Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions man/ostree-admin-status.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,65 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
</para>
</refsect1>

<refsect1>
<title>Options</title>

<variablelist>
<varlistentry>
<term><option>--sysroot</option>="PATH"</term>

<listitem><para>
Create a new OSTree sysroot at PATH
</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-V, --verify</option></term>

<listitem><para>
Print the commit verification status
</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-S, --skip-signatures</option></term>

<listitem><para>
Skip signatures in output
</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-Q, --query-booted</option></term>

<listitem><para>
Output the string <literal>default</literal> if the default deployment
is the booted one, <literal>not-default</literal> if we are booted in
a non-default deployment (e.g. the user interactively chose a
different entry in the bootloader menu, or the bootloader rolled back
automatically, etc.). If we are not in a booted OSTree system, an
error is returned.
</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-v, --verbose</option></term>

<listitem><para>
Print debug information during command processing
</para></listitem>
</varlistentry>

<varlistentry>
<term><option>--version</option>--version</term>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the syntax correct here?


<listitem><para>
Print version information and exit
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1>
<title>Example</title>
<para><command>$ ostree admin status</command></para>
Expand Down
32 changes: 24 additions & 8 deletions src/ostree/ot-admin-builtin-status.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,21 @@

static gboolean opt_verify;
static gboolean opt_skip_signatures;

static GOptionEntry options[]
= { { "verify", 'V', 0, G_OPTION_ARG_NONE, &opt_verify, "Print the commit verification status",
NULL },
{ "skip-signatures", 'S', 0, G_OPTION_ARG_NONE, &opt_skip_signatures,
"Print the commit verification status", NULL },
{ NULL } };
static gboolean opt_query_booted;

static GOptionEntry options[] = {
{ "verify", 'V', 0, G_OPTION_ARG_NONE, &opt_verify, "Print the commit verification status",
NULL },
{ "skip-signatures", 'S', 0, G_OPTION_ARG_NONE, &opt_skip_signatures, "Skip signatures in output",
NULL },
{ "query-booted", 'Q', 0, G_OPTION_ARG_NONE, &opt_query_booted,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is pure bikeshed, but I think this would be better named e.g. --is-default. Somewhat precedence are the systemctl is-* commands that also print strings. --query-booted is a bit ambiguous.

"Output the string \"default\" if the default deployment is the booted one, \"not-default\" if "
"we are booted in a non-default deployment (e.g. the user interactively chose a different "
"entry in the bootloader menu, or the bootloader rolled back automatically, etc.). If we are "
"not in a booted OSTree system, an error is returned.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: this is duplicating the manpage. These docstrings are usually more brief. Maybe e.g.

Output "default" if booted into the default deployment, otherwise "not-default"

?

NULL },
{ NULL }
};
static gboolean
deployment_print_status (OstreeSysroot *sysroot, OstreeRepo *repo, OstreeDeployment *deployment,
gboolean is_booted, gboolean is_pending, gboolean is_rollback,
Expand Down Expand Up @@ -200,7 +208,15 @@ ot_admin_builtin_status (int argc, char **argv, OstreeCommandInvocation *invocat
if (booted_deployment)
ostree_sysroot_query_deployments_for (sysroot, NULL, &pending_deployment, &rollback_deployment);

if (deployments->len == 0)
if (opt_query_booted)
{
if (deployments->len == 0)
return glnx_throw (error, "Not in a booted OSTree system");

const gboolean is_default_booted = deployments->pdata[0] == booted_deployment;
g_print ("%s\n", is_default_booted ? "default" : "not-default");
}
else if (deployments->len == 0)
{
g_print ("No deployments.\n");
}
Expand Down
Loading