Skip to content

[release/1.3] build: Fix manpage generation#3748

Merged
estesp merged 1 commit intocontainerd:release/1.3from
seemethere:fix_man_1_3
Oct 14, 2019
Merged

[release/1.3] build: Fix manpage generation#3748
estesp merged 1 commit intocontainerd:release/1.3from
seemethere:fix_man_1_3

Conversation

@seemethere
Copy link
Copy Markdown
Contributor

Seems to be that docs/man/ctr.1.md and docs/man/containerd.1.md were
removed in #3637 and were not updated correctly in the Makefile, leading
to build failures like:

+ make man

make: *** No rule to make target `man/ctr.1', needed by `man'.  Stop.

Changes the gen-manpages command to be specific on which manpages are to
be generated.

Same as #3729 but for the release/1.3 branch

Signed-off-by: Eli Uriegas [email protected]
(cherry picked from commit 036db34)
Signed-off-by: Eli Uriegas [email protected]

Seems to be that docs/man/ctr.1.md and docs/man/containerd.1.md were
removed in containerd#3637 and were not updated correctly in the Makefile, leading
to build failures like:

    + make man

    make: *** No rule to make target `man/ctr.1', needed by `man'.  Stop.

Changes the gen-manpages command to be specific on which manpages are to
be generated.

Signed-off-by: Eli Uriegas <[email protected]>
(cherry picked from commit 036db34)
Signed-off-by: Eli Uriegas <[email protected]>
@theopenlab-ci
Copy link
Copy Markdown

theopenlab-ci Bot commented Oct 11, 2019

Build succeeded.

@codecov-io
Copy link
Copy Markdown

Codecov Report

Merging #3748 into release/1.3 will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           release/1.3   #3748   +/-   ##
===========================================
  Coverage         45.6%   45.6%           
===========================================
  Files              116     116           
  Lines            11458   11458           
===========================================
  Hits              5225    5225           
  Misses            5334    5334           
  Partials           899     899
Flag Coverage Δ
#linux 45.6% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b43a31...ffb05ae. Read the comment docs.

Comment thread .travis.yml
- go build -i .
- make check
- if [ "$GOOS" = "linux" ]; then make check-protos check-api-descriptors; fi
- if [ "$TRAVIS_GOOS" = "linux" ]; then make man ; fi
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

what's the difference between GOOS and TRAVIS_GOOS, if both are used from .travis.yml?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, we should probably check what the differences are (if any) and clean up (if possible); either put a comment why use one over the other, or remove one of both (because it's definitely confusing)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

TRAVIS_GOOS is just defined in the env section and used in this yml, it has no other meaning. Not sure why GOOS is used above, but TRAVIS_GOOS should be used here since we set it and know what it is set to.

Copy link
Copy Markdown
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread .travis.yml
- go build -i .
- make check
- if [ "$GOOS" = "linux" ]; then make check-protos check-api-descriptors; fi
- if [ "$TRAVIS_GOOS" = "linux" ]; then make man ; fi
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, we should probably check what the differences are (if any) and clean up (if possible); either put a comment why use one over the other, or remove one of both (because it's definitely confusing)

Comment thread cmd/gen-manpages/main.go
dir := flag.Arg(1)
app, ok := apps[name]
if !ok {
return fmt.Errorf("Invalid application '%s'", name)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Guess this should've been lowercase

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I though the linters were complaining about this, maybe just a warning. Should fix upstream though if we have to, fine for now

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes; this is just a cherry-pick, but was also surprised the linter didn't make it fail

Copy link
Copy Markdown
Member

@dmcgowan dmcgowan left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Member

@estesp estesp left a comment

Choose a reason for hiding this comment

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

LGTM

@estesp estesp merged commit 1c3929e into containerd:release/1.3 Oct 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants