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

Jump to bottom

src/xbps/index.md: Link to void-packages/Manual.md #639

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

src/xbps/index.md: Link to void-packages/Manual.md #639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion src/xbps/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,14 @@ Most general package management is done with the following commands:
Most questions can be answered by consulting the man pages for these tools,
together with the [xbps.d(5)](https://man.voidlinux.org/xbps.d.5) man page.

To learn how to build packages from source, refer to [the README for the
To learn how to build packages from source, refer to [the README of the
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems like a pedantic change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree.

Copy link
Member

Choose a reason for hiding this comment

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

This should be:

  1. Unchanged, which is idiomatic;
  2. "the README in the void-packages repository", if there is some compelling reason that "for" is inappropriate; or
  3. Something simpler like "the void-packages README".

The word "of" conveys a possessive quality that the repository itself cannot manifest. It is not correct here.

void-packages
repository](https://github.com/void-linux/void-packages/blob/master/README.md).

To learn how to create new package templates, refer to [the Manual of the
void-packages
repository](https://github.com/void-linux/void-packages/blob/master/Manual.md).
Comment on lines +37 to +39
Copy link
Member

Choose a reason for hiding this comment

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

Can we phrase this in a different way from the previous paragraph? Just copying it and changing a few words doesn't make it readable. It could be something like "..., Manual.md in the same repository describes how to create, update or modify packages."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Generally, of course yes. But I actually find it pretty readable this way. I did not just copy it because I'm lazy, I just wanted to keep it as simple as possible. IMO, the repetition kind of emphasizes the difference between building packages and creating package templates. Your version right now says "create, update or modify packages", but "create packages" could be misunderstood for "building packages" by beginners, as @abenson mentioned. I would stick with "package templates" in the second sentence. I would also omit the "update" in your version, since that could still be misunderstood for updating the packages on the system, and also it's included in "modifying packages" IMO.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe a broader rewrite will better clarify the distinction:

The [README] provides a general overview of xbps-src and instructions for building packages locally from existing templates. For information about adding new templates or altering existing templates, refer to the [Manual].


## Updating

Like any other system, it is important to keep Void up-to-date. Use
Expand Down