Clean up docs on and add tab completion for buildcache command #5125
Conversation
This file contains 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
adamjstewart
commented
Aug 16, 2017
|
|
||
| Build caches are created via: | ||
|
|
||
| .. code-block:: sh | ||
| .. code-block:: console |
There was a problem hiding this comment.
This is a command run at the console, not a shell script.
adamjstewart
commented
Aug 16, 2017
| need to be adjusted for better re-locatability. | ||
|
|
||
| .. _cmd-spack-buildcache: |
There was a problem hiding this comment.
This adds a link in the Command Index.
|
Looks OK to me. |
adamjstewart
commented
Aug 16, 2017
| -k <key> : the key to sign package with. In the case where multiple keys exist, the package will be unsigned unless -k is used. | ||
| -r : make paths in binaries relative before creating tarball | ||
| -y : answer yes to all create unsigned "build_cache" questions | ||
| <> : list of package specs or package hashes with leading / |
There was a problem hiding this comment.
Previously, this entire section was on a single line: http://spack.readthedocs.io/en/latest/binary_caches.html#spack-buildcache-create
Reformatted to use a table.
adamjstewart
commented
Aug 16, 2017
| command_index | ||
| package_list | ||
| binary_caches |
There was a problem hiding this comment.
The last 2 sections here are lists of packages and links to other docs, not the kind of documentation that people read. I moved Build Caches above these, as people are likely to skip Command Index and Package List when reading the docs.
|
@adamjstewart Thanks! I never did get time to build the docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
spack buildcachecommand was added a couple days ago in #4854, but there were a couple things missing:This PR adds tab completion and updates the docs to fit better with the rest of our documentation.
@gartung Can you see if these changes look good to you?