Convert short nix options to long ones #1280
Conversation
e.g. nix-env -e subversion => nix-env --uninstall subversion The aim is to make the documention less cryptic for newcomers and the long options are more self-documenting. The change was made with the following script: <https://github.com/aschmolck/convert-short-nix-opts-to-long-ones> and sanity checked visually.
|
I marked this as stale due to inactivity. → More info |
|
@aschmolck I manually fixed/transformed from .xml to .md in #1349 ... as this is now marked stale do you want to try fix this again with your script? |
|
Sure, I'm happy to spend a bit of time to fix the markdown version of the docs, if that's the only thing that's in the way of landing this. Can someone with commit access confirm they are interested in merging this change in principle? |
Not sure what the chances are for stale issues :-( |
|
@copumpkin since you're currently assigned to this (and 👍 the original PR 3 years ago), can you comment on whether me bringing it up to date is worth it? (edit: I'm happy to do it, but obviously I'd rather not spend the time if there is little chance of it getting merged). |
|
I marked this as stale due to inactivity. → More info |
|
@aschmolck Really sorry that your PR has been hanging around for so long. Are you still interested in merging this? If so, could you please rebase? |
|
@fricklerhandwerk because this is generated from a script, I suggest we merge your PR to split up the man pages first, and then rerun the script. That should be less rebasing and resolving conflicts. |
|
Sorry, I missed that there was some renewed interest in this PR @Ericson2314 @fricklerhandwerk. I'm happy to bring it up to date by re-running the scripts (and doing some manual fixups where needed), if that's all that's needed to land this? |
|
@aschmolck nice! I agree with @Ericson2314 though that we should merge the large manual PR first. |
thufschmitt
added
the
idea approved
|
#7518 is now merged, so let's do this! I guess the easiest thing to do is re-run the script, and then force push? |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-03-31-nix-team-meeting-minutes-45/27002/1 |
|
@Ericson2314 Cool, I'll have a look at this later today. |
|
@Ericson2314 this actually required a bit of work to bring up-to-date and I also I also found a small bug in nix-info along the way and had to create a new PR (since I no longer have access to the original repo), but here we go: #8276 |
e.g. nix-env -e subversion => nix-env --uninstall subversion
The aim is to make the documention less cryptic for newcomers and the long
options are more self-documenting.
The change was made with the following script:
https://github.com/aschmolck/convert-short-nix-opts-to-long-ones
and sanity checked visually.