| Message ID | 1452031164-28504-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Commit | 93c2bc83420131ee7e20d435ea040a80511cca03 |
| Headers | show |
On Tue, Jan 5, 2016 at 3:59 PM, Mike Holmes <mike.holmes@linaro.org> wrote: > Using callouts relates the diagram to the text much more effectively in > the finished document > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > doc/implementers-guide/implementers-guide.adoc | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) > > diff --git a/doc/implementers-guide/implementers-guide.adoc > b/doc/implementers-guide/implementers-guide.adoc > index 8964b0c..b9f865b 100644 > --- a/doc/implementers-guide/implementers-guide.adoc > +++ b/doc/implementers-guide/implementers-guide.adoc > @@ -22,19 +22,19 @@ tree, but leave the actual definitions to be defined > by the specific platform. > ./ > ├── include/ > │ ├── odp/ > -│ │ └── api/ > +│ │ └── api/ <1> > │ │ └── The Public API and the documentation. > │ │ > -│ └── odp.h This file should be the only file included by the > application. > +│ └── odp.h <4> This file should be the only file included by the > application. > │ > ├── platform/ > │ ├── <implementation name>/ > │ │ ├── include/ > -│ │ │ ├── odp/ > +│ │ │ ├── odp/ <2> > │ │ │ │ ├── In-line function definitions of the public API for > this > │ │ │ │ │ platform seen by the application. > │ │ │ │ │ > -│ │ │ │ └── plat/ > +│ │ │ │ └── plat/ <3> > │ │ │ │ └── Platform specific types, enums etc as seen by the > │ │ │ │ application but require overriding by the > │ │ │ │ implementation. > @@ -42,16 +42,16 @@ tree, but leave the actual definitions to be defined > by the specific platform. > │ │ │ └── Internal header files seen only by the implementation. > ---- > > -The doxygen description of the API definition is held in the public api > file > +<1> The doxygen description of the API definition is held in the public > api file > 'include/odp/api'. > -This file is included by a counterpart in > +<2> The public file is included by a counterpart in > 'platform/<implementation name>/include/odp'. > The include of the public API is AFTER the platform specific definitions > to > allow the platform to provide definitions that match the underlying > hardware. > -The implementation code includes 'platform/<implementation > name>/include/plat' > +<3> The implementation code includes 'platform/<implementation > name>/include/plat' > and this then provides the source files with a complete definition the > ODP API > to be implemented. > -Applications in turn include the include/odp.h file which includes the > +<4> Applications in turn include the include/odp.h file which includes the > 'platform/<implementation name>/include/plat' files to provide a complete > definition of the API. > > -- > 2.5.0 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
Merged. On 5 January 2016 at 18:13, Bill Fischofer <bill.fischofer@linaro.org> wrote: > > > On Tue, Jan 5, 2016 at 3:59 PM, Mike Holmes <mike.holmes@linaro.org> > wrote: > >> Using callouts relates the diagram to the text much more effectively in >> the finished document >> >> Signed-off-by: Mike Holmes <mike.holmes@linaro.org> >> > > Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> > > >> --- >> doc/implementers-guide/implementers-guide.adoc | 16 ++++++++-------- >> 1 file changed, 8 insertions(+), 8 deletions(-) >> >> diff --git a/doc/implementers-guide/implementers-guide.adoc >> b/doc/implementers-guide/implementers-guide.adoc >> index 8964b0c..b9f865b 100644 >> --- a/doc/implementers-guide/implementers-guide.adoc >> +++ b/doc/implementers-guide/implementers-guide.adoc >> @@ -22,19 +22,19 @@ tree, but leave the actual definitions to be defined >> by the specific platform. >> ./ >> ├── include/ >> │ ├── odp/ >> -│ │ └── api/ >> +│ │ └── api/ <1> >> │ │ └── The Public API and the documentation. >> │ │ >> -│ └── odp.h This file should be the only file included by the >> application. >> +│ └── odp.h <4> This file should be the only file included by the >> application. >> │ >> ├── platform/ >> │ ├── <implementation name>/ >> │ │ ├── include/ >> -│ │ │ ├── odp/ >> +│ │ │ ├── odp/ <2> >> │ │ │ │ ├── In-line function definitions of the public API for >> this >> │ │ │ │ │ platform seen by the application. >> │ │ │ │ │ >> -│ │ │ │ └── plat/ >> +│ │ │ │ └── plat/ <3> >> │ │ │ │ └── Platform specific types, enums etc as seen by the >> │ │ │ │ application but require overriding by the >> │ │ │ │ implementation. >> @@ -42,16 +42,16 @@ tree, but leave the actual definitions to be defined >> by the specific platform. >> │ │ │ └── Internal header files seen only by the implementation. >> ---- >> >> -The doxygen description of the API definition is held in the public api >> file >> +<1> The doxygen description of the API definition is held in the public >> api file >> 'include/odp/api'. >> -This file is included by a counterpart in >> +<2> The public file is included by a counterpart in >> 'platform/<implementation name>/include/odp'. >> The include of the public API is AFTER the platform specific definitions >> to >> allow the platform to provide definitions that match the underlying >> hardware. >> -The implementation code includes 'platform/<implementation >> name>/include/plat' >> +<3> The implementation code includes 'platform/<implementation >> name>/include/plat' >> and this then provides the source files with a complete definition the >> ODP API >> to be implemented. >> -Applications in turn include the include/odp.h file which includes the >> +<4> Applications in turn include the include/odp.h file which includes >> the >> 'platform/<implementation name>/include/plat' files to provide a complete >> definition of the API. >> >> -- >> 2.5.0 >> >> _______________________________________________ >> lng-odp mailing list >> lng-odp@lists.linaro.org >> https://lists.linaro.org/mailman/listinfo/lng-odp >> > > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc index 8964b0c..b9f865b 100644 --- a/doc/implementers-guide/implementers-guide.adoc +++ b/doc/implementers-guide/implementers-guide.adoc @@ -22,19 +22,19 @@ tree, but leave the actual definitions to be defined by the specific platform. ./ ├── include/ │ ├── odp/ -│ │ └── api/ +│ │ └── api/ <1> │ │ └── The Public API and the documentation. │ │ -│ └── odp.h This file should be the only file included by the application. +│ └── odp.h <4> This file should be the only file included by the application. │ ├── platform/ │ ├── <implementation name>/ │ │ ├── include/ -│ │ │ ├── odp/ +│ │ │ ├── odp/ <2> │ │ │ │ ├── In-line function definitions of the public API for this │ │ │ │ │ platform seen by the application. │ │ │ │ │ -│ │ │ │ └── plat/ +│ │ │ │ └── plat/ <3> │ │ │ │ └── Platform specific types, enums etc as seen by the │ │ │ │ application but require overriding by the │ │ │ │ implementation. @@ -42,16 +42,16 @@ tree, but leave the actual definitions to be defined by the specific platform. │ │ │ └── Internal header files seen only by the implementation. ---- -The doxygen description of the API definition is held in the public api file +<1> The doxygen description of the API definition is held in the public api file 'include/odp/api'. -This file is included by a counterpart in +<2> The public file is included by a counterpart in 'platform/<implementation name>/include/odp'. The include of the public API is AFTER the platform specific definitions to allow the platform to provide definitions that match the underlying hardware. -The implementation code includes 'platform/<implementation name>/include/plat' +<3> The implementation code includes 'platform/<implementation name>/include/plat' and this then provides the source files with a complete definition the ODP API to be implemented. -Applications in turn include the include/odp.h file which includes the +<4> Applications in turn include the include/odp.h file which includes the 'platform/<implementation name>/include/plat' files to provide a complete definition of the API.
Using callouts relates the diagram to the text much more effectively in the finished document Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- doc/implementers-guide/implementers-guide.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)