Document missing Makefile recipes in Top_Makefile.md#17
Open
Shivam-Shukla0 wants to merge 1 commit into
Open
Conversation
The top-level Makefile provides six recipes but Top_Makefile.md only described lint and strict_lint. This documents local_spyglass, remote_spyglass, init and questa.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The top-level Makefile has six recipes (
lint,strict_lint,local_spyglass,remote_spyglass,init,questa) butdoc/Top_Makefile.mdonly described the first two.This adds short descriptions for the remaining four, following the same style as the existing entries.
initseemed worth documenting especially, since it's what enables the repo's pre-commit hook.Fixes #15