[ARCH] crypto_design: remove table of revision history

Message ID 1405608783-10033-1-git-send-email-anders.roxell@linaro.org
State New
Headers show

Commit Message

Anders Roxell July 17, 2014, 2:53 p.m.
This revision history reflects the 1.0 crypto draft document and it is
not a revision history of the full architecture document.

Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
---
 crypto_design.dox | 10 ----------
 1 file changed, 10 deletions(-)

Comments

Bill Fischofer July 17, 2014, 3:01 p.m. | #1
I don't see what harm there is in retaining this history.  The overall
architecture doc is being built by sections and this information is part of
the history of this section.  It seems like we're fixing a non-existent
problem here?

Bill


On Thu, Jul 17, 2014 at 9:53 AM, Anders Roxell <anders.roxell@linaro.org>
wrote:

> This revision history reflects the 1.0 crypto draft document and it is
> not a revision history of the full architecture document.
>
> Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
> ---
>  crypto_design.dox | 10 ----------
>  1 file changed, 10 deletions(-)
>
> diff --git a/crypto_design.dox b/crypto_design.dox
> index 4124537..34e6c6f 100644
> --- a/crypto_design.dox
> +++ b/crypto_design.dox
> @@ -10,16 +10,6 @@ For the implimentation of the ODP crypto API please see
> @ref odp_crypto.h
>
>  @tableofcontents
>
> -@section revision_history Revision History
> -Revision | Issue Data | Description | Author
> ----------|------------|-------------|--------
> -0.1      | 4/9/2014   | Introduction started, Basic Functions | Bill,
> Alexandru
> -0.2      | 4/15/2014  | Completed intro, added TOC, started use cases,
> miscellaneous formatting, API comments | Bill
> -0.3      | 4/22/2014  | Added Use Case section to include results of
> design discussions held during ODP team calls | Bill
> -0.4      | 4/30/2014  | Design review from ODP crypto sprint--action to
> resolve | Bill
> -0.5      | 5/5/2014   | Rewrite incorporating review comments--ready for
> final review | Bill
> -1.0      | 5/30/2014  | Final version for LNG-SC approval | Bill
> -
>  @section introduction Introduction
>  This document describes the ODP Crypto API.
>  Cryptography is an important part of data plane processing as many
> communication protocols make use of cryptographic functions.
> --
> 1.9.1
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Anders Roxell July 17, 2014, 3:46 p.m. | #2
On 2014-07-17 10:01, Bill Fischofer wrote:
> I don't see what harm there is in retaining this history.  The overall
> architecture doc is being built by sections and this information is part of
> the history of this section.  It seems like we're fixing a non-existent
> problem here?

 Draft documents that contribute to the full released architecture
 doc have their own history in a table within themselves in the google
 doc - the full released Arch doc has its history recorded in git.
 The full Arch doc is not a collection of other docs in my opinion it
 should form a single cohesive document from those contributions that
 lives and it improved with additional material and corrections over
 time.

Cheers,


> 
> Bill
> 
> 
> On Thu, Jul 17, 2014 at 9:53 AM, Anders Roxell <anders.roxell@linaro.org>
> wrote:
> 
> > This revision history reflects the 1.0 crypto draft document and it is
> > not a revision history of the full architecture document.
> >
> > Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
> > ---
> >  crypto_design.dox | 10 ----------
> >  1 file changed, 10 deletions(-)
> >
> > diff --git a/crypto_design.dox b/crypto_design.dox
> > index 4124537..34e6c6f 100644
> > --- a/crypto_design.dox
> > +++ b/crypto_design.dox
> > @@ -10,16 +10,6 @@ For the implimentation of the ODP crypto API please see
> > @ref odp_crypto.h
> >
> >  @tableofcontents
> >
> > -@section revision_history Revision History
> > -Revision | Issue Data | Description | Author
> > ----------|------------|-------------|--------
> > -0.1      | 4/9/2014   | Introduction started, Basic Functions | Bill,
> > Alexandru
> > -0.2      | 4/15/2014  | Completed intro, added TOC, started use cases,
> > miscellaneous formatting, API comments | Bill
> > -0.3      | 4/22/2014  | Added Use Case section to include results of
> > design discussions held during ODP team calls | Bill
> > -0.4      | 4/30/2014  | Design review from ODP crypto sprint--action to
> > resolve | Bill
> > -0.5      | 5/5/2014   | Rewrite incorporating review comments--ready for
> > final review | Bill
> > -1.0      | 5/30/2014  | Final version for LNG-SC approval | Bill
> > -
> >  @section introduction Introduction
> >  This document describes the ODP Crypto API.
> >  Cryptography is an important part of data plane processing as many
> > communication protocols make use of cryptographic functions.
> > --
> > 1.9.1
> >
> >
> > _______________________________________________
> > lng-odp mailing list
> > lng-odp@lists.linaro.org
> > http://lists.linaro.org/mailman/listinfo/lng-odp
> >
Anders Roxell July 25, 2014, 2:59 p.m. | #3
On 17 July 2014 17:46, Anders Roxell <anders.roxell@linaro.org> wrote:

> On 2014-07-17 10:01, Bill Fischofer wrote:
> > I don't see what harm there is in retaining this history.  The overall
> > architecture doc is being built by sections and this information is part
> of
> > the history of this section.  It seems like we're fixing a non-existent
> > problem here?
>
>  Draft documents that contribute to the full released architecture
>  doc have their own history in a table within themselves in the google
>  doc - the full released Arch doc has its history recorded in git.
>  The full Arch doc is not a collection of other docs in my opinion it
>  should form a single cohesive document from those contributions that
>  lives and it improved with additional material and corrections over
>  time.
>

So are we OK with applying this now?

Cheers,
Anders


>
> Cheers,
>
>
> >
> > Bill
> >
> >
> > On Thu, Jul 17, 2014 at 9:53 AM, Anders Roxell <anders.roxell@linaro.org
> >
> > wrote:
> >
> > > This revision history reflects the 1.0 crypto draft document and it is
> > > not a revision history of the full architecture document.
> > >
> > > Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
> > > ---
> > >  crypto_design.dox | 10 ----------
> > >  1 file changed, 10 deletions(-)
> > >
> > > diff --git a/crypto_design.dox b/crypto_design.dox
> > > index 4124537..34e6c6f 100644
> > > --- a/crypto_design.dox
> > > +++ b/crypto_design.dox
> > > @@ -10,16 +10,6 @@ For the implimentation of the ODP crypto API please
> see
> > > @ref odp_crypto.h
> > >
> > >  @tableofcontents
> > >
> > > -@section revision_history Revision History
> > > -Revision | Issue Data | Description | Author
> > > ----------|------------|-------------|--------
> > > -0.1      | 4/9/2014   | Introduction started, Basic Functions | Bill,
> > > Alexandru
> > > -0.2      | 4/15/2014  | Completed intro, added TOC, started use cases,
> > > miscellaneous formatting, API comments | Bill
> > > -0.3      | 4/22/2014  | Added Use Case section to include results of
> > > design discussions held during ODP team calls | Bill
> > > -0.4      | 4/30/2014  | Design review from ODP crypto sprint--action
> to
> > > resolve | Bill
> > > -0.5      | 5/5/2014   | Rewrite incorporating review comments--ready
> for
> > > final review | Bill
> > > -1.0      | 5/30/2014  | Final version for LNG-SC approval | Bill
> > > -
> > >  @section introduction Introduction
> > >  This document describes the ODP Crypto API.
> > >  Cryptography is an important part of data plane processing as many
> > > communication protocols make use of cryptographic functions.
> > > --
> > > 1.9.1
> > >
> > >
> > > _______________________________________________
> > > lng-odp mailing list
> > > lng-odp@lists.linaro.org
> > > http://lists.linaro.org/mailman/listinfo/lng-odp
> > >
>
> --
> Anders Roxell
> anders.roxell@linaro.org
> M: +46 709 71 42 85 | IRC: roxell
>
Bill Fischofer July 25, 2014, 3:44 p.m. | #4
I'm OK with these changes.


On Fri, Jul 25, 2014 at 9:59 AM, Anders Roxell <anders.roxell@linaro.org>
wrote:

>
>
>
> On 17 July 2014 17:46, Anders Roxell <anders.roxell@linaro.org> wrote:
>
>> On 2014-07-17 10:01, Bill Fischofer wrote:
>> > I don't see what harm there is in retaining this history.  The overall
>> > architecture doc is being built by sections and this information is
>> part of
>> > the history of this section.  It seems like we're fixing a non-existent
>> > problem here?
>>
>>  Draft documents that contribute to the full released architecture
>>  doc have their own history in a table within themselves in the google
>>  doc - the full released Arch doc has its history recorded in git.
>>  The full Arch doc is not a collection of other docs in my opinion it
>>  should form a single cohesive document from those contributions that
>>  lives and it improved with additional material and corrections over
>>  time.
>>
>
> So are we OK with applying this now?
>
> Cheers,
> Anders
>
>
>>
>> Cheers,
>>
>>
>> >
>> > Bill
>> >
>> >
>> > On Thu, Jul 17, 2014 at 9:53 AM, Anders Roxell <
>> anders.roxell@linaro.org>
>> > wrote:
>> >
>> > > This revision history reflects the 1.0 crypto draft document and it is
>> > > not a revision history of the full architecture document.
>> > >
>> > > Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
>> > > ---
>> > >  crypto_design.dox | 10 ----------
>> > >  1 file changed, 10 deletions(-)
>> > >
>> > > diff --git a/crypto_design.dox b/crypto_design.dox
>> > > index 4124537..34e6c6f 100644
>> > > --- a/crypto_design.dox
>> > > +++ b/crypto_design.dox
>> > > @@ -10,16 +10,6 @@ For the implimentation of the ODP crypto API
>> please see
>> > > @ref odp_crypto.h
>> > >
>> > >  @tableofcontents
>> > >
>> > > -@section revision_history Revision History
>> > > -Revision | Issue Data | Description | Author
>> > > ----------|------------|-------------|--------
>> > > -0.1      | 4/9/2014   | Introduction started, Basic Functions | Bill,
>> > > Alexandru
>> > > -0.2      | 4/15/2014  | Completed intro, added TOC, started use
>> cases,
>> > > miscellaneous formatting, API comments | Bill
>> > > -0.3      | 4/22/2014  | Added Use Case section to include results of
>> > > design discussions held during ODP team calls | Bill
>> > > -0.4      | 4/30/2014  | Design review from ODP crypto sprint--action
>> to
>> > > resolve | Bill
>> > > -0.5      | 5/5/2014   | Rewrite incorporating review comments--ready
>> for
>> > > final review | Bill
>> > > -1.0      | 5/30/2014  | Final version for LNG-SC approval | Bill
>> > > -
>> > >  @section introduction Introduction
>> > >  This document describes the ODP Crypto API.
>> > >  Cryptography is an important part of data plane processing as many
>> > > communication protocols make use of cryptographic functions.
>> > > --
>> > > 1.9.1
>> > >
>> > >
>> > > _______________________________________________
>> > > lng-odp mailing list
>> > > lng-odp@lists.linaro.org
>> > > http://lists.linaro.org/mailman/listinfo/lng-odp
>> > >
>>
>> --
>> Anders Roxell
>> anders.roxell@linaro.org
>> M: +46 709 71 42 85 | IRC: roxell
>>
>
>
Mike Holmes July 28, 2014, 12:32 p.m. | #5
On 17 July 2014 10:53, Anders Roxell <anders.roxell@linaro.org> wrote:

> This revision history reflects the 1.0 crypto draft document and it is
> not a revision history of the full architecture document.
>
> Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
>
Tested-By:Mike Holmes <mike.holmes@linaro.org>

> ---
>  crypto_design.dox | 10 ----------
>  1 file changed, 10 deletions(-)
>
> diff --git a/crypto_design.dox b/crypto_design.dox
> index 4124537..34e6c6f 100644
> --- a/crypto_design.dox
> +++ b/crypto_design.dox
> @@ -10,16 +10,6 @@ For the implimentation of the ODP crypto API please see
> @ref odp_crypto.h
>
>  @tableofcontents
>
> -@section revision_history Revision History
> -Revision | Issue Data | Description | Author
> ----------|------------|-------------|--------
> -0.1      | 4/9/2014   | Introduction started, Basic Functions | Bill,
> Alexandru
> -0.2      | 4/15/2014  | Completed intro, added TOC, started use cases,
> miscellaneous formatting, API comments | Bill
> -0.3      | 4/22/2014  | Added Use Case section to include results of
> design discussions held during ODP team calls | Bill
> -0.4      | 4/30/2014  | Design review from ODP crypto sprint--action to
> resolve | Bill
> -0.5      | 5/5/2014   | Rewrite incorporating review comments--ready for
> final review | Bill
> -1.0      | 5/30/2014  | Final version for LNG-SC approval | Bill
> -
>  @section introduction Introduction
>  This document describes the ODP Crypto API.
>  Cryptography is an important part of data plane processing as many
> communication protocols make use of cryptographic functions.
> --
> 1.9.1
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Anders Roxell July 28, 2014, 12:58 p.m. | #6
On 2014-07-28 08:32, Mike Holmes wrote:
> On 17 July 2014 10:53, Anders Roxell <anders.roxell@linaro.org> wrote:
> 
> > This revision history reflects the 1.0 crypto draft document and it is
> > not a revision history of the full architecture document.
> >
> > Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
> >
> Tested-By:Mike Holmes <mike.holmes@linaro.org>

Applied, thanks!

Patch

diff --git a/crypto_design.dox b/crypto_design.dox
index 4124537..34e6c6f 100644
--- a/crypto_design.dox
+++ b/crypto_design.dox
@@ -10,16 +10,6 @@  For the implimentation of the ODP crypto API please see @ref odp_crypto.h
 
 @tableofcontents
 
-@section revision_history Revision History
-Revision | Issue Data | Description | Author
----------|------------|-------------|--------
-0.1      | 4/9/2014   | Introduction started, Basic Functions | Bill, Alexandru
-0.2      | 4/15/2014  | Completed intro, added TOC, started use cases, miscellaneous formatting, API comments | Bill
-0.3      | 4/22/2014  | Added Use Case section to include results of design discussions held during ODP team calls | Bill
-0.4      | 4/30/2014  | Design review from ODP crypto sprint--action to resolve | Bill
-0.5      | 5/5/2014   | Rewrite incorporating review comments--ready for final review | Bill
-1.0      | 5/30/2014  | Final version for LNG-SC approval | Bill
-
 @section introduction Introduction
 This document describes the ODP Crypto API.
 Cryptography is an important part of data plane processing as many communication protocols make use of cryptographic functions.