aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2015-10-15doc: implementers-guide: update section on skipping testsStuart Haslam
Update sections describing how a specific platform may skip tests by marking them as inactive. Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org> Reviewed-by: Christophe Milard <christophe.milard@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-10-15doc: implementers-guide: update names of test module librariesStuart Haslam
The name of the libraries generated by the test modules were recently changed from lib<module>.la to libtest<module>.la Signed-off-by: Stuart Haslam <stuart.haslam@linaro.org> Reviewed-by: Christophe Milard <christophe.milard@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-09-07doc: implementers add include structureMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-08-11doc: implementers-guide: add validation descriptionChristophe Milard
Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-07-31doc: publish contributing textMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-07-15doc: examples: add classifier exampleMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-07-15doc: doxygen: Add Converter function guidelinesMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-07-03doc: doxygen: improve release management descriptionMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-06-10doc: use only WITH_PLATFORM and not always linux-genericNicolas Morey-Chaisemartin
Signed-off-by: Nicolas Morey-Chaisemartin <nmorey@kalray.eu> Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-06-05codespell: fix spellingMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-04-23example: doxygen: remove examples from src pathMike Holmes
If the examples are on the src path they pollute the documentation with their own declarations. The correct mechanism is to declare the examples to be seen in the documentation in one location that is on the .dox path, and have the EXAMPLE_PATH locate the actual example code. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Anders Roxell <anders.roxell@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-04-23doc: api_guide_lines: add guidance on ODP_DEPRECATEDMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-04-17doc: doxygen.cfg: removed reference to l2fwdMike Holmes
l2fwd is no longer an example Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-04-14doc: odpdoxygen.css: clean up styleMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Anders Roxell <anders.roxell@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-04-14doc: doxygen.cfg: add platform to titleMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Anders Roxell <anders.roxell@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-03-30doc: doxygen: add declaring variablesMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-03-25linux-generic: strongtypes: use named structs for C++Ola Liljedahl
Typedefs to anonymous structs creates problems for C++ programs: GCC: warning: ‘odp_crypto_op_params’ has a field ‘odp_crypto_op_params::pkt’ whose type uses the anonymous namespace error: anonymous type with no linkage used to declare function ‘<anonymous struct>* ppp_packet::get_queue() const’ with linkage CLANG: extern odp_pool_t tmo_pool; warning: variable 'tmo_pool' has internal linkage but is not defined When linking: undefined reference to `tmo_pool' The solution is to add a (unique) name to all structs used by the strong typing typedefs. Signed-off-by: Ola Liljedahl <ola.liljedahl@linaro.org> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-03-17doc: move api guidelines to API docMike Holmes
This documentation was moved from the architecture doc to this API doc. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-02-27doc: clean up doxygen first page textMaxim Uvarov
Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-29api: align: move platform defines out of public APIAnders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-29api: byteorder: move types documentation out of linux-genericTaras Kondratiuk
Signed-off-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-29doc: cfg: fix structure attributes parsingTaras Kondratiuk
Signed-off-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-29doc: cfg: disable TYPEDEF_HIDES_STRUCTTaras Kondratiuk
Signed-off-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-29api: move generic API into the odp namespaceAnders Roxell
Move generic API into an api directory. Force the platform implementation to add its own header file that shall include the generic API header file. This splitup enables platform implementors to implement inline functions without modifying the "public" API files. Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-29api: move ODP headers to a directoryTaras Kondratiuk
Signed-off-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-21doc: cleanup doxygen build rulesAnders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Steve McIntyre <steve.mcintyre@linaro.org> Reviewed-and-tested-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-21doc: Makefile: fix make cleanAnders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Steve McIntyre <steve.mcintyre@linaro.org> Reviewed-and-tested-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-21doc: Makefile: remove cruftAnders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Steve McIntyre <steve.mcintyre@linaro.org> Reviewed-and-tested-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-01-05doc: doxygen.cfg: remove odp_exampleMike Holmes
odp_example has been moved to test/performance and is no longer an example Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Maxim Uvarov <maxim.uvraov@linaro.org>
2014-12-23configure: add a check if doxygen is installedAnders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-and-Tested-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2014-12-23doc: move Makefile structure into doc dirAnders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-and-Tested-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2014-12-12odp version scriptMaxim Uvarov
Update odp version in one place (C code), and use it for doxygen also. Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org> Reviewed-and-tested-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Anders Roxell <anders.roxell@linaro.org>
2014-12-08Update version number from 0.3.0 to 0.4.0Maxim Uvarov
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org> Reviewed-by: Mike Holmes <mike.holmes@linaro.org>
2014-10-23doxygen: remove api.doxAnders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2014-10-21odp.dox: fix bug urlMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2014-10-08doc: remove example/ipsec from doxygenMike Holmes
ipsec has an exemption from inclusion in the documentation due to its complexity. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2014-10-02guide.dox: remove dpdk & KS2 guidesMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2014-09-07enable building doxygen per platformAnders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-and-Tested-by: Stuart Haslam <stuart.haslam@arm.com> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2014-09-02move helper functions and rename to prefix to odph_Anders Roxell
Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Acked-by: Petri Savolainen <petri.savolainen@linaro.org> Reviewed-by: Stuart Haslam <stuart.haslam@arm.com> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2014-08-22Move includes back into linux-genericAnders Roxell
To much linux-generic specific details. Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-and-Tested-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org>
2014-07-29doxygen reorganisationAnders Roxell
1. To make the structure better 2. To have a Users Guide 3. Remove out of date content Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Tested-by: Mike Holmes <mike.holmes@linaro.org>
2014-05-05Documentation Split mainpage from headderMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2014-01-30Docs: Update overview images to match other docsMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2014-01-27Add ODP logo to the docsMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2014-01-27doc: Add ODP specific cascading style sheetMike Holmes
Change-Id: I20034835d203286a2de7b9dcfb5de6d6cab613ad Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2013-12-18Provide reference image inclusion for the introduction.mike-holmes
Change-Id: I9c0dbc37a6e2dc195a09615e30fa3fbf6b279ce7
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-02 19:16:42 +0000