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

Add documentation for running clang-format #60

Merged
merged 2 commits into from
Jan 20, 2022

Conversation

sherry-yuan
Copy link
Contributor

Document which clang version to run to avoid workflow failure, clang-format git integration as well installation instruction.

@sherry-yuan sherry-yuan requested a review from pcolberg January 17, 2022 21:33
@sherry-yuan sherry-yuan marked this pull request as ready for review January 17, 2022 21:33
Copy link
Contributor

@pcolberg pcolberg left a comment

Choose a reason for hiding this comment

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

Thanks @sherry-yuan, your documentation will make it much easier to pass the clang-format workflow on first try.

@pcolberg pcolberg added the documentation Improvements or additions to documentation label Jan 17, 2022
@pcolberg pcolberg added this to the 2022.2 milestone Jan 17, 2022
@pcolberg pcolberg linked an issue Jan 17, 2022 that may be closed by this pull request
@pcolberg pcolberg force-pushed the clang-install branch 2 times, most recently from 1bd97df to a01ecd8 Compare January 20, 2022 00:43
pcolberg
pcolberg previously approved these changes Jan 20, 2022
@pcolberg
Copy link
Contributor

Thanks @sherry-yuan. I cosmetically revised the Markdown to make it somewhat readable in raw format, but otherwise left everything as is. Good thinking on writing a temporary test of a failing clang-format run 🙂

@pcolberg
Copy link
Contributor

pcolberg commented Jan 20, 2022

Since I noticed you committed additions with message fixup: You can use git commit --fixup=<commit> to replicate the subject of an earlier commit, preceded by fixup!. When everything is ready for squashing, git rebase -i --autosquash intel/main automatically squashes these commits, discarding their messages.

<commit> can be any "commit-ish", but usually HEAD, HEAD^, etc. is convenient.

Document which clang version to run to avoid workflow failure, clang-format git integration as well installation instruction.
@pcolberg pcolberg merged commit 7cbb69f into intel:main Jan 20, 2022
pcolberg added a commit to pcolberg/fpga-runtime-for-opencl that referenced this pull request Jan 20, 2022
@sherry-yuan
Copy link
Contributor Author

I see, thanks for the tip @pcolberg !

pcolberg added a commit that referenced this pull request Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add clang-format git integration and clang-format installation script
2 participants