From 17d4e829441a76e31d4c9ed2cec37e154f6e4661 Mon Sep 17 00:00:00 2001 From: Morgan Bauer Date: Mon, 23 Nov 2015 12:59:51 -0800 Subject: [PATCH] Formatting content digest calculation to avoid copyright symbols - resolves #1197 Signed-off-by: Morgan Bauer --- docs/spec/api.md | 20 ++++++++++---------- docs/spec/api.md.tmpl | 20 ++++++++++---------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/spec/api.md b/docs/spec/api.md index 552f79850..320d752fd 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -290,10 +290,11 @@ portion. The _algorithm_ identifies the methodology used to calculate the digest. The _hex_ portion is the hex-encoded result of the hash. We define a _digest_ string to match the following grammar: - - digest := algorithm ":" hex - algorithm := /[A-Fa-f0-9_+.-]+/ - hex := /[A-Fa-f0-9]+/ +``` +digest := algorithm ":" hex +algorithm := /[A-Fa-f0-9_+.-]+/ +hex := /[A-Fa-f0-9]+/ +``` Some examples of _digests_ include the following: @@ -313,7 +314,6 @@ uniqueness of the _digest_ but some canonicalization may be performed to ensure consistent identifiers. Let's use a simple example in pseudo-code to demonstrate a digest calculation: - ``` let C = 'a small string' let B = sha256(C) @@ -321,11 +321,11 @@ let D = 'sha256:' + EncodeHex(B) let ID(C) = D ``` -Above, we have bytestring _C_ passed into a function, _SHA256_, that returns a -bytestring B, which is the hash of _C_. _D_ gets the algorithm concatenated -with the hex encoding of _B_. We then define the identifier of _C_ to _ID(C)_ -as equal to _D_. A digest can be verified by independently calculating _D_ and -comparing it with identifier _ID(C)_ +Above, we have bytestring `C` passed into a function, `SHA256`, that returns a +bytestring `B`, which is the hash of `C`. `D` gets the algorithm concatenated +with the hex encoding of `B`. We then define the identifier of `C` to `ID(C)` +as equal to `D`. A digest can be verified by independently calculating `D` and +comparing it with identifier `ID(C)`. #### Digest Header diff --git a/docs/spec/api.md.tmpl b/docs/spec/api.md.tmpl index 044f57e55..3f74d40a2 100644 --- a/docs/spec/api.md.tmpl +++ b/docs/spec/api.md.tmpl @@ -290,10 +290,11 @@ portion. The _algorithm_ identifies the methodology used to calculate the digest. The _hex_ portion is the hex-encoded result of the hash. We define a _digest_ string to match the following grammar: - - digest := algorithm ":" hex - algorithm := /[A-Fa-f0-9_+.-]+/ - hex := /[A-Fa-f0-9]+/ +``` +digest := algorithm ":" hex +algorithm := /[A-Fa-f0-9_+.-]+/ +hex := /[A-Fa-f0-9]+/ +``` Some examples of _digests_ include the following: @@ -313,7 +314,6 @@ uniqueness of the _digest_ but some canonicalization may be performed to ensure consistent identifiers. Let's use a simple example in pseudo-code to demonstrate a digest calculation: - ``` let C = 'a small string' let B = sha256(C) @@ -321,11 +321,11 @@ let D = 'sha256:' + EncodeHex(B) let ID(C) = D ``` -Above, we have bytestring _C_ passed into a function, _SHA256_, that returns a -bytestring B, which is the hash of _C_. _D_ gets the algorithm concatenated -with the hex encoding of _B_. We then define the identifier of _C_ to _ID(C)_ -as equal to _D_. A digest can be verified by independently calculating _D_ and -comparing it with identifier _ID(C)_ +Above, we have bytestring `C` passed into a function, `SHA256`, that returns a +bytestring `B`, which is the hash of `C`. `D` gets the algorithm concatenated +with the hex encoding of `B`. We then define the identifier of `C` to `ID(C)` +as equal to `D`. A digest can be verified by independently calculating `D` and +comparing it with identifier `ID(C)` #### Digest Header