Pack client deb hwlib hwctl #253
Open
+219
−211
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Creates one source package that produces two binaries (librust-hwlib-dev and hwctl) * Moves debian/ dir under the client/ folder * Updates the debian/generate-checksum.py script to generate the cargo-checksum.json file only for the hwlib as required * Rewrite the dh_auto_install section in the debian/rules file since dh-cargo tries to install the whole workspace as a package. The changes install the hwlib as a library and hwctl as a binary package, repeating the logic implemented in dh-cargo source code.
Since now we pack both hwlib and hwctl, this information in located in the workspace Cargo.toml file
…pdated workspace structure
nadzyah
force-pushed
the
pack-client-deb-hwlib-hwctl
branch
from
a5542e0
to
12ea915
Compare
zyga
reviewed
Dec 4, 2024
| does not accept any command-line options. | ||
| .SH ENVIRONMENT | ||
| .TP | ||
| .B HW_API_URL |
| Ubuntu Hardware Certification Program, visit | ||
| https://ubuntu.com/certified. | ||
| .SH OPTIONS | ||
| .B hwctl |
| .SH NAME | ||
| hwctl \- CLI tool to check hardware certification status | ||
| .SH SYNOPSIS | ||
| .B hwctl |
| .B hwctl | ||
| .SH DESCRIPTION | ||
| .B hwctl | ||
| is a command-line tool that checks the Ubuntu Hardware Certification |
There was a problem hiding this comment.
I would put it like that:
Suggested change
| is a command-line tool that checks the Ubuntu Hardware Certification | |
| is a command-line tool that checks the | |
| .Em Ubuntu Hardware Certification |
| @@ -0,0 +1,28 @@ | |||
| .TH HWCTL 1 "03 Dec 2024" "Canonical Ltd." | |||
| .SH NAME | |||
| hwctl \- CLI tool to check hardware certification status | |||
There was a problem hiding this comment.
This should be
Suggested change
| hwctl \- CLI tool to check hardware certification status | |
| .Nm hwctl | |
| .Nd check status of Ubuntu Hardware Certification |
| .SH SYNOPSIS | ||
| .B hwctl | ||
| .SH DESCRIPTION | ||
| .B hwctl |
There was a problem hiding this comment.
This should be .Nm
Suggested change
| .B hwctl | |
| .Nm hwctl |
| the certification covers for it. Also, note that root privileges are | ||
| typically required to run this command. For more information about the | ||
| Ubuntu Hardware Certification Program, visit | ||
| https://ubuntu.com/certified. |
There was a problem hiding this comment.
Suggested change
| https://ubuntu.com/certified. | |
| .Lk https://ubuntu.com/certified "The cerfification website" . |
| Specifies the hardware-api server URL that | ||
| .B hwctl | ||
| uses for certification queries. The default value is | ||
| https://hw.ubuntu.com |
| uses for certification queries. The default value is | ||
| https://hw.ubuntu.com | ||
| .SH BUGS | ||
| https://github.com/canonical/hardware-api/issues/ |
There was a problem hiding this comment.
Please add a paragraph, not just the URL and use .Lk
| .SH BUGS | ||
| https://github.com/canonical/hardware-api/issues/ | ||
| .SH COPYRIGHT | ||
| Copyright (C) 2024 Canonical Ltd. |
There was a problem hiding this comment.
You can include this in a SPDX expression but the man page should not mention it. Put up
.Sh AUTHORS
Instead please.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes C3-913.
With these changes, the source client package now provides two binaries:
librust-hwlib-devandhwctl. To make such packaging possible, the' Debian/folder and workspaceCargo.*files were moved to theclient/` folder.Key changes:
debian/rulesfile was updated with an overridden dh_auto_install section. It was donedh-cargotreats the whole workspace as a single package, either library or binary package. For more information, check https://salsa.debian.org/rust-team/dh-cargo/-/blob/5cc7f7b8/cargo.pm#L168-195debian/generate-checksum.pyscript was updated to generate thecargo-checksum.jsonfile only for the files in thehwlibdir, since it's needed only for the library packageshwctl.1man page was added since it's required for CLI tools