#1354 Add shell completions section
Merged by james. Opened by principis.
principis/packaging-committee shell-completions  into  master

Download 1354.patch

Adds section for shell-completions and a MUST on using the macros as approved(I think?) here.

Looks pretty good to me, thanks!

Bikeshedding nit-pick: Technically %{buildroot} has a trailing slash, so there doesn't need to be an additional slash between %{buildroot} and %{foo_completions_dir}, but this is somewhat an issue of consistency and / or taste. It certainly looks clearer (at least to me) if the additional slash is present.

Thanks for working on this! I would remove the extra slashes that Fabio mentioned. Also, I am not a fan of the Recommends: bash-completion. I don't think that was discussed in the parent issue and is not common practice.

Is this intended to be a requirement (MUST), or something lesser like SHOULD or even just "consider adding Recommends: bash-completion"?

I agree, the Recommends for bash-completion weren't discussed anywhere, and I don't think it is necessary.

Thanks for the remarks!

  • Removed the slash after %{buildroot}
  • Removed reference to bash-completion

2 new commits added

  • `Remove unnecessary/after%{buildroot}```
  • Remove reference to `bash-completion` package

3 new commits added

  • Remove unnecessary / after %{buildroot}
  • Remove reference to `bash-completion` package
  • Add shell completions section

Force pushed because pagure wasn't happy with the backticks

It's worth at least thinking about whether this should simply be a MUST. Is there any use case at all for executable permissions, or something less accessible like 0600?

Nit: I would sort the shells alphabetically in the examples and table (bash, fish, zsh).

And finally, could you squash these commits so the history doesn't have the unwanted sections added and then removed?

rebased onto 98e76c0c02853080cbc82fd394474c803f54d9d4

rebased onto 4f759d7e815fa9b7c048f00071daa85c8413a5f9

Done, thanks!

  • Changed should -> MUST 0644
  • Sorted shells
  • squashed commits

Thanks. I'll +1 here in case we don't get to meet this week

Metadata Update from @tibbs:
- Pull-request tagged with: meeting

LGTM. +1

Not sure if the formatting in the table is correct though.

The table appears to render correctly for me when I check out the PR and build locally. At least it renders no differently than the table in KDE Packaging or Naming. I guess most of what's in there could all be monospaced since we not unusual to do that for macros or pathnames, but we don't really do that consistently throughout the guidelines.

rebased onto c9414e3b6c8e3f7a00f16afdf6532fd89d1dc0e6

I forgot the second column. Not sure how that happened, fixed it.

Perfect, thanks!

Any updates on the meeting?

rebased onto ec76818f787640238f0afb6c00faf17ac40f66c1

+1 to the changes here

Additional suggestion:

Directory ownership

The directories listed in the table above are owned by the filesystem package.
Packages installing files to them MUST NOT own the directories.

rebased onto 7db48db638b6fcf3c86b707a7b7a52bfe99d2536

Pull-Request has been merged by james

Metadata