Create edit ppa documentation#561
Conversation
odadacharles
left a comment
There was a problem hiding this comment.
Thanks for working on this @jugmac00 . I've left some comments and suggestions.
| - :guilabel:`Publish` -- whether the apt repository is updated. If | ||
| disabled, nothing is published; for a private PPA no builds are | ||
| dispatched either. | ||
| - :guilabel:`Build debug symbols` -- create debug symbol packages for |
There was a problem hiding this comment.
What's a debug symbol package and will someone learning how to create and edit PPAs know what it is.
There was a problem hiding this comment.
A debug symbol is a map that connects compiled, machine-readable binary code back to human-readable source code. When a program is built for normal use, these symbols are stripped out to drastically reduce the file size.
Without debug symbols, if a program crashes, your debugger (like gdb) will only show raw memory addresses (e.g., 0x00007fff8234). With debug symbols enabled, it translates those addresses into actual function names, source file paths, and exact line numbers (e.g., main.c: line 42).
In Ubuntu, debug symbols are packed into special packages ending in -dbgsym and formatted as .ddeb files.
I would not want to add all these infos on the PPA page.
I just checked the Ubuntu Project Docs, and they have a full page for that topic, but that also focuses on getting debug symbols for the archive.
https://ubuntu.com/server/docs/how-to/debugging/debug-symbol-packages/
Ideally, we would have a glossary on our own docs, which could give some background info.
I think we can follow up after this PR.
There was a problem hiding this comment.
I see we have one, see https://ubuntu.com/docs/launchpad/user/reference/glossary/ - but that needs some love.
@odadacharles Would you consider adding this to your list of documents to revise? I am happy to work on that in my next doc rotation.
| A PPA can depend on other archives, so that packages published in those | ||
| archives are available when building packages in your PPA. Dependencies can be |
There was a problem hiding this comment.
| A PPA can depend on other archives, so that packages published in those | |
| archives are available when building packages in your PPA. Dependencies can be | |
| A PPA can have dependencies in other archives, such that packages published in those | |
| archives are required/called when building packages in your PPA. Dependencies can be |
There was a problem hiding this comment.
I think the current phrasing is more correct ("depend on other archives"), and easier to understand. I will keep the current wording.
| - Choose which packages of the distribution's primary archive are | ||
| used as build dependencies (for example :guilabel:`Basic`, | ||
| :guilabel:`Security`, :guilabel:`Default`, :guilabel:`Proposed` | ||
| or :guilabel:`Backports`). |
There was a problem hiding this comment.
| - Choose which packages of the distribution's primary archive are | |
| used as build dependencies (for example :guilabel:`Basic`, | |
| :guilabel:`Security`, :guilabel:`Default`, :guilabel:`Proposed` | |
| or :guilabel:`Backports`). | |
| - Choose which packages of the distribution's primary archive are | |
| used as build dependencies (for example Basic, Security, Default, Proposed, Backports). |
Once again, intention. Having these as GUI elements is too rigid for what they are
There was a problem hiding this comment.
They are GUI elements. See e.g. https://launchpad.net/~launchpad/+archive/ubuntu/buildd/+edit-dependencies. I'd like to keep them as is.
Extend the "create PPA" how-to with a "Manage archive dependencies" section covering both the web interface and the web service API, following the existing tabbed layout used elsewhere on the page. Dependencies can be managed through the +edit-dependencies view or via the API. Pin priorities are currently API-only, so the pin_priority usage (including changing an existing dependency and the PPA-only restriction) is documented within the web service API tab, and the web interface tab notes that pinning is not yet available there.
6ecab48 to
4ac2f07
Compare
|
Thanks a lot for your review, @odadacharles. I have applied most of the suggested changes, and followed up otherwise in the comments. For a second round of reviews, maybe the following diff makes it easier, as I already have squashed the commits. |
No description provided.