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

Update README.md instructions for running doxygen #4807

Merged

Conversation

jafingerhut
Copy link
Contributor

No description provided.

@jafingerhut jafingerhut requested a review from fruffy July 15, 2024 18:19
@jafingerhut
Copy link
Contributor Author

@AdarshRawat1 These changes make sense to me regarding my confusions about running doxygen. Let me know if you see anything in these changes that is different than what you would recommend.

In particular, if we want to recommend using cmake with -DENABLE_DOCS=ON, it would be good to make those instructions work. Right now all of my attempts to use those steps have resulted in an error message, as mentioned in this issue: #4805

Copy link
Collaborator

@fruffy fruffy left a comment

Choose a reason for hiding this comment

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

Conditional approval pending @AdarshRawat1 's review.

@fruffy fruffy added the documentation Topics related to compiler documentation. label Jul 15, 2024
@jafingerhut
Copy link
Contributor Author

@fruffy I am guessing the one failing test has nothing to do with changes to the README.md. I am leaving it there for now, in case you want to examine it and see if its root cause looks familiar to you. I do not know why it occurred.

@fruffy
Copy link
Collaborator

fruffy commented Jul 15, 2024

Looks like a racecondition to me. Not quite clear why the Python lex/yacc code is sharing state here.

@jafingerhut
Copy link
Contributor Author

@AdarshRawat1 Could you please take a look at these changes and give any comments, or suggestions for further changes, that you think of?

@AdarshRawat1
Copy link
Member

@AdarshRawat1 Could you please take a look at these changes and give any comments, or suggestions for further changes, that you think of?

Since we only have a stable configuration for HTML output, these changes make total sense.

@jafingerhut jafingerhut added this pull request to the merge queue Jul 19, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 19, 2024
@jafingerhut jafingerhut added this pull request to the merge queue Jul 19, 2024
Merged via the queue into p4lang:main with commit 6ae5875 Jul 19, 2024
17 checks passed
@jafingerhut jafingerhut deleted the update-readme-doxygen-instructions branch July 19, 2024 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants