acpiconf(8): Add libxo(3) support

[me_cameronkatri.com]

Summary

Simplifies reading battery info from scripts.

Test Plan

• Ensured text output is the same before and after libxo support.

[me_cameronkatri.com]

Run xo_finish(3) after all instances of xo_errx(3)

[me_cameronkatri.com]

Add full context.

[phil]

Looks good. You can use {L:} for strings that include slashes by escaping them with double backslashes (one for C, one for me):

xo_emit("{Lc:Warn\\/full granularity}{P:\t}{:granularity-wf/%d}{Uw:/%sh}\n", ...

Thanks,
Phil

[phil]

FYI: I've just added docs for this, so it will be in the next release, which I'll import shortly, but the functionality's already there.

Thanks,
Phil

[phil]

In D30350#681699, @me_cameronkatri.com wrote:

Run xo_finish(3) after all instances of xo_errx(3)

xo_errx doesn't return; no further calls are needed/possible.

FWIW xo_errx() calls xo_finish() before calling exit().

Thanks,
Phil

[me_cameronkatri.com]

In D30350#687708, @phil wrote:

In D30350#681699, @me_cameronkatri.com wrote:

Run xo_finish(3) after all instances of xo_errx(3)

xo_errx doesn't return; no further calls are needed/possible.

FWIW xo_errx() calls xo_finish() before calling exit().

Thanks,
Phil

However if you don’t encounter any errors you still need to run xo_finish(3).

• Cameron

[me_cameronkatri.com]

In D30350#687688, @phil wrote:

Looks good. You can use {L:} for strings that include slashes by escaping them with double backslashes (one for C, one for me):

xo_emit("{Lc:Warn\\/full granularity}{P:\t}{:granularity-wf/%d}{Uw:/%sh}\n", ...

Thanks,
Phil

I could swear I tried this, I’ll update the patch shortly.

• Cameron

[me_cameronkatri.com]

Correct escaping of slashes

[phil]

In D30350#687710, @me_cameronkatri.com wrote:

I could swear I tried this, I’ll update the patch shortly.

Well, retest to ensure I'm not lying, but I just verified it as working in libxo/develop and even added an explicit test case for it, as well as docs.

Thanks,
Phil

[me_cameronkatri.com]

In D30350#687753, @phil wrote:

In D30350#687710, @me_cameronkatri.com wrote:

I could swear I tried this, I’ll update the patch shortly.

Well, retest to ensure I'm not lying, but I just verified it as working in libxo/develop and even added an explicit test case for it, as well as docs.

Thanks,
Phil

I checked it already, and it worked.

• Cameron

[imp]

usr.sbin/acpi/acpiconf/acpiconf.c

248

You don't check the return value of argc here. Do you need to?

[me_cameronkatri.com]

Check argc after xo_parse_args().

[me_cameronkatri.com]

usr.sbin/acpi/acpiconf/acpiconf.c

248

I checked quite a few bins and it seems that most check argc.

[phil]

Yes, you need to check it. See xo_parse_args(3):

       On failure, a message it emitted and -1 is returned.

	       argc = xo_parse_args(argc, argv);
	       if (argc < 0)
		   exit(EXIT_FAILURE);

[phil]

Cameron,

You said "it seems that most check"; did you find ones that didn't?

Thanks,
Phil

[me_cameronkatri.com]

In D30350#714235, @phil wrote:

Cameron,

You said "it seems that most check"; did you find ones that didn't?

Thanks,
Phil

I found one that doesn't check argc: procstat(1).

[me_cameronkatri.com]

Update manpage date.

[pauamma_gundo.com]

Manual page change LGTM.

[me_cameronkatri.com]

Sorry to bother, but was just wondering if someone could review this as it's been stale for a while.

[debdrup]

Manual page change looks good to me.

[phil]

Looks good. I do see an error on this site that says some nameless file is missing a terminating newline.

Thanks,
Phil

[pauamma_gundo.com]

usr.sbin/acpi/acpiconf/acpiconf.8

100

Since you're touching this area.

[me_cameronkatri.com]

Good morning, what's the status on getting this landed?

[phil]

Sorry for the delay.

Thanks,
Phil

usr.sbin/acpi/acpiconf/acpiconf.8

55

Refer to xo_options(7) instead, since it's user-level documentation, rather than programmer level.

108

ditto; hmm... maybe I should write a user-level version of libxo(3).

usr.sbin/acpi/acpiconf/acpiconf.c

248

Yes, you should be checking xo_parse_args return, so that you catch invalid arguments:

argc = xo_parse_args(argc, argv);
if (argc < 0)
    exit(EXIT_FAILURE);

[me_cameronkatri.com]

• Check xo_parse_args(3) for error.
• Reference xo_options(7) in manpage.

[me_cameronkatri.com]

usr.sbin/acpi/acpiconf/acpiconf.8

55

Wow, can't believe I never knew that page existed. All other programs with libxo seem to reference xo_parse_args(3)...

[pauamma_gundo.com]

Manual page change LGTM. Can't assess the source.

[phil]

usr.sbin/acpi/acpiconf/acpiconf.8

55

Okay. I'll check and correct as needed.

Thanks,
Phil

[markj]

Is there some reason that this didn't land?