aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2016-03-29rename libodphelper to libodphelper-linuxAnders Roxell
Rename to unify the library names for different implementations. Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Ricardo Salveti <ricardo.salveti@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-29rename libodp to libodp-linuxAnders Roxell
Rename to unify the library names for different implementations. Signed-off-by: Anders Roxell <anders.roxell@linaro.org> Reviewed-by: Ricardo Salveti <ricardo.salveti@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-28doc: userguide: add thread type description to odp_init_local() discussionBill Fischofer
This addresses Bug https://bugs.linaro.org/show_bug.cgi?id=2058 Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-15doc: userguide: add PktIO chapter to ODP User GuideBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Christophe Milard <christophe.milard@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-15doc: images: add additional svg images used for PktIO chapterBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Christophe Milard <christophe.milard@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-15doc: images: add gv file for pktio state machineBill Fischofer
The PktIO FSM state diagram is built using GraphVis. Add the files and associated Makefile and .gitignore changes needed to support this new file. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Christophe Milard <christophe.milard@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-04doc: users: fix TM typosMike Holmes
Suggested-by: Anders Roxell <anders.roxell@linaro.org> 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>
2016-03-04doc: users: add TM exampleMike 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>
2016-03-04doc: users: migrate TM from API to users docMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-04doc: implementers-guide: adding drv interfaceChristophe Milard
The driver interface structure (similar to the api) is described. Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-04doc: descr of structure for new interfacesChristophe Milard
updates of the documentation to reflect the new structure allowing new interface addition. Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-04doc: user-guide documentation for classificationBalasubramanian Manoharan
User guide documentation for classification Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> Reviewed-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-04documentation: userguide: add packet processing descriptionBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-04documentation: userguide: add images for packet processingBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-04linux-generic: separate x86 ODP_CACHE_LINE_SIZE to its arch fileHongbo Zhang
Currently all ODP_CACHE_LINE_SIZE macros for different architectures are held in one header file, they should be moved to their own arch file. This patch moves ODP_CACHE_LINE_SIZE for x86. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Hongbo Zhang <hongbo.zhang@linaro.org> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-04doc: images: add traffic manager svgMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-03-02configure.ac: distribute the AC_CONFIG_FILESMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Christophe Milard <christophe.milard@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-02-25doc: removing invalid charactersChristophe Milard
linux "tree" command output contains non printable character 160 which made its way into the asciidoc. Removed and replaced by space here. Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-02-25doc: user-guide: fixing other typosChristophe Milard
Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-02-25doc: user-guide: shmemChristophe Milard
section regarding shared memo added. Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-02-25doc: glossary: defining ODP thread more preciselyChristophe Milard
Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-02-25doc: depend the docs on the imagesMike Holmes
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>
2016-02-25doc: use imagedir attribute for pathMike Holmes
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>
2016-02-25doc: update to latest ax_prog_doxygen.m4Mike Holmes
fixes https://bugs.linaro.org/show_bug.cgi?id=1946 Move to the latest m4 scripts for doxygen and revert to using it without modification, thus make doxygen-html becomes make doxygen-doc. Also cleans up the last parts of the previously removed .pdf support. 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>
2016-02-25doc: drop using output dir for guidesMike Holmes
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>
2016-02-08doc: remove imagemagic dependency and use svg diagrams in all asciidocsBill Fischofer
Simplify ODP documentation builds by using .svg files directly for all images. This eliminates the need to create .png and .eps files via the imagemagic package. Note that this removes easy PDF output for ODP user documents, however there is no real demand for such capability. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-02-08doc: user-guide: clarify scheduler operation for atomic queuesBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2016-01-28doc: doxygen: use .svg logoMike Holmes
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>
2016-01-28doc: doxygen: generate .svg not .png tree graphsMike Holmes
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>
2016-01-27doc: make docs build conditionallyMike Holmes
Currently docs will build the images regardless of the setting for enable-user-docs at configure time. The image generation should be dependent on actually building docs so that systems without the image tools installed will not generate warnings. 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>
2016-01-25doc: implementers-guide: inactive precond testsChristophe Milard
Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-01-25doc: implementers-guide: conditional testsChristophe Milard
Documentation on conditional test is added here, as it seemed to be missing Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-01-22doc: identify asciidocs to search enginesMike Holmes
Search engines are not currently indexing the documentation, add a title and description. 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>
2016-01-22doc: process: add by-lawsMike Holmes
The by-laws were only recorded as part of the website, move them to git where they can be tracked. 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>
2016-01-15doc: move api docs to application-api-guideMike Holmes
The other documentation is contained in its own directory, the API guide for the application should be no different. This also makes way for a possible south-bound API for NIC drivers 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>
2016-01-13doc: implementers-guide: libC versionChristophe Milard
Limiting the usage of the C library to the functions defined in its C99 version. Signed-off-by: Christophe Milard <christophe.milard@linaro.org> Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2016-01-11doc: images: refactor makefileMike Holmes
Drop per target rules for generic make Suggested-by: Anders Roxell <anders.roxell@linaro.og> 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>
2016-01-11doc: factor out asciidoc build ruleMike 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>
2016-01-07doc: implementers: use calloutsMike Holmes
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> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2016-01-07doc: implementers: fix link to modules listMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2016-01-07doc: factor out the glossaryMike Holmes
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2016-01-07doc: users-guide: fix function highlightingMike Holmes
Use "*" for function highlighting and promote crypto to its own section from a subsection of queues Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2016-01-06doc: release-guide: add deprecated api sectionMike Holmes
Describe how changes to the public api are handled from release to release. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-and-Tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
2015-12-29doc/users-guide: add time API sectionIvan Khoronzhuk
Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Ivan Khoronzhuk <ivan.khoronzhuk@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-12-17doc/users-guide: add cryptographic services sectionAlexandru Badicioiu
Signed-off-by: Alexandru Badicioiu <alexandru.badicioiu@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-12-14doc: userguide: add application programming sectionBill Fischofer
Complete the reformatting to standard asciidoc style, expand the ODP Application Programming section, and include a reorganized and expanded discussion of ODP queues. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2015-12-10doc: process-guide: add release processMike Holmes
The release process was recorded in the ODP webpage and not tracked in git. This meant that changes to the release process could not be tracked. Convert to ascii doc src in git and generate it 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-12-10doc: images: replace overview with editable svg srcMike Holmes
The overview diagram is the only binary image used, all the other images are stored as the .svg source that is easy to edit. 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-12-07doc: guides: embed icons and images in htmlMike Holmes
The icons in the generated guide have a system dependent location. If the system used to view the docs does not have asciidoc installed no icons will be displayed. Embed the images so that the output is self-contained. 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-11-30doc: userguide: add baseline overview to documentBill Fischofer
Add a basic ODP overview to the User's Guide, providing an overview of ODP concepts, components, etc. Included are a number of diagrams covering component structure as well as packet RX, event scheduling, and packet TX processing. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Mike Holmes <mike.holmes@linaro.org Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-17 00:50:40 +0000