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

Ensure 'doc' Make Target Is Supported; Add Diagnostic Information If Documentation Is Disabled #1503

Merged

Conversation

gerickson
Copy link
Contributor

Problem

If make help is invoked, it indicates that a doc target exists that will build documentation. However, there is not presently such a target.

Summary of Changes

Ensure the doc target is supported per make help. Also, provide useful diagnostic information if Doxygen is not available or if documentation support has been explicitly disabled.

Fixes #1498

Grant Erickson added 2 commits July 8, 2020 06:50
…seful diagnostic infomration if Doxygen is not available or if documentation support has been explicitly disabled.
Copy link
Contributor

@vivien-apple vivien-apple left a comment

Choose a reason for hiding this comment

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

LGTM. Just tried it and it works. I hope most people won't be confused by the message saying that you need to install Doxygen and hope it will then just works. In my understanding you need to regenerate the Makefile too.

@woody-apple
Copy link
Contributor

@andy31415 andy31415 merged commit c56ec54 into project-chip:master Jul 9, 2020
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.

Make make help True for make doc
6 participants