Skip to content

Commit

Permalink
fix documentation tests in crypto library
Browse files Browse the repository at this point in the history
  • Loading branch information
reset authored and fnichol committed Apr 10, 2016
1 parent a1cff34 commit ea63a9a
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions components/core/src/crypto.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,25 +57,24 @@ use util::perm;
///
/// Example origin key file names ("sig" keys):
///
/// ```text
/// habitat-201603312016.pub
/// habitat-201603312016.sig.key
/// your_company-201604021516.pub
/// your_company-201604021516.sig.key
/// ```
/// habitat-201603312016.pub
/// habitat-201603312016.sig.key
/// your_company-201604021516.pub
/// your_company-201604021516.sig.key
/// ```
///
///
/// Example user keys ("box" keys)
///
/// ```
/// [email protected]
/// [email protected]
/// ```text
/// [email protected]
/// [email protected]
/// ```
///
/// Example Service keys:
///
/// ```
/// [email protected]
/// ```text
/// [email protected]
/// ```
///
/// ### Habitat signed artifact format
Expand All @@ -92,7 +91,7 @@ use util::perm;
/// public origin key. Thus, it it safe to distribute public origin keys.
///
/// Example header:
/// ```
/// ```text
/// habitat-20160405144945
/// BLAKE2b
/// signed BLAKE2b signature
Expand All @@ -103,7 +102,7 @@ use util::perm;
///
/// It's possible to examine the contents of a `.hab` file from a Linux shell:
///
/// ```
/// ```text
/// $ head -3 /opt/bldr/cache/pkgs/chef-glibc-2.22-20160310192356.bldr
/// habitat-20160405144945
/// BLAKE2b
Expand All @@ -113,12 +112,10 @@ use util::perm;
///
/// It is also possible to extract a plain tarball from a signed `.hab` artifact using the following command:
///
/// ```
/// ```text
/// tail -n +4 /tmp/somefile.hab > somefile.tar
/// # start at line 4, skipping the first 3 plaintext lines.
/// ```
///
///
/// The suffix on the end of a public sig/box file
static PUB_KEY_SUFFIX: &'static str = "pub";
Expand Down

1 comment on commit ea63a9a

@chef-delivery
Copy link
Contributor

Choose a reason for hiding this comment

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

Delivery Status:

Verify Build Acceptance
<a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/verify', target='_blank'><img src='https://img.shields.io/badge/Unit-Passed-brightgreen.svg', alt='Unit'> <a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/build', target='_blank'><img src='https://img.shields.io/badge/Unit-Passed-brightgreen.svg', alt='Unit'> <a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/acceptance', target='_blank'><img src='https://img.shields.io/badge/Provision-Failed-red.svg', alt='Provision'>
<a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/verify', target='_blank'><img src='https://img.shields.io/badge/Lint-Passed-brightgreen.svg', alt='Lint'> <a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/build', target='_blank'><img src='https://img.shields.io/badge/Lint-Passed-brightgreen.svg', alt='Lint'>
<a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/verify', target='_blank'><img src='https://img.shields.io/badge/Syntax-Skipped-lightgrey.svg', alt='Syntax'> <a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/build', target='_blank'><img src='https://img.shields.io/badge/Syntax-Skipped-lightgrey.svg', alt='Syntax'>
<a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/build', target='_blank'><img src='https://img.shields.io/badge/Quality-Skipped-lightgrey.svg', alt='Quality'>
<a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/build', target='_blank'><img src='https://img.shields.io/badge/Security-Skipped-lightgrey.svg', alt='Security'>
<a href='https://delivery.chef.co/e/chef/#/organizations/bldr/projects/bldr/changes/add009c3-e791-4aaf-96de-4aa2867fcde3/status/build', target='_blank'><img src='https://img.shields.io/badge/Publish-Skipped-lightgrey.svg', alt='Publish'>

Please sign in to comment.