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.

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

Fix for man pages do not build reproducibly #68983

Merged

Conversation

dims
Copy link
Member

@dims dims commented Sep 23, 2018

What this PR does / why we need it:

In different distros or environments, we may end up with a different
order of the strings printed during help and man page generation,
So we should sort so the strings in the man pages is the same everytime.

Change-Id: Id8fcbd89336aad8d709ba3adac4b29c808d97ebe

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #52269

Special notes for your reviewer:
Please see #48710 (comment)

Release note:

NONE

In different distros or environments, we may end up with a different
order of the strings printed during help and man page generation,
So we should sort so the strings in the man pages is the same everytime.

Change-Id: Id8fcbd89336aad8d709ba3adac4b29c808d97ebe
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Sep 23, 2018
@dims
Copy link
Member Author

dims commented Sep 23, 2018

/kind bug

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. and removed needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Sep 23, 2018
@bmwiedemann
Copy link
Contributor

bmwiedemann commented Sep 23, 2018

still had a diff:

 \fB\-o\fP, \fB\-\-output\fP="yaml"
-    Output format. One of: json|yaml|name|templatefile|template|go\-template|go\-template\-file|jsonpath|jsonpath\-file.
+    Output format. One of: json|yaml|name|template|go\-template|go\-template\-file|templatefile|jsonpath|jsonpath\-file.

seems to come from pkg/kubectl/cmd/util/printing.go
but probably with transformations applied

@dims
Copy link
Member Author

dims commented Sep 23, 2018

@bmwiedemann can you please paste the whole diff somewhere?

Also one of the full man pages too (from your environment)

@bmwiedemann
Copy link
Contributor

I had not properly applied the patch - will retest later.

@bmwiedemann
Copy link
Contributor

yes! patch works 👍

@dims
Copy link
Member Author

dims commented Sep 23, 2018

/assign @soltysh
/assign @deads2k

@juanvallejo
Copy link
Member

@dims Thanks!

/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Sep 24, 2018
Copy link
Contributor

@soltysh soltysh left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dims, juanvallejo, soltysh

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 0064c6f into kubernetes:master Sep 27, 2018
@dims dims mentioned this pull request Oct 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

man pages do not build reproducibly
6 participants