portugalfuturista/seL4
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2167 commits 1 branch 42 tags 18 MiB
Commit graph

126 commits

Author SHA1 Message Date
Bruce Mitchener
b942a50441 Fix trivial comment typos. 2018-03-27 10:51:26 +11:00
Anna Lyons
05b83acd95 SELFOUR-1016: Require auth cap to set prio/mcp 
This fixes confused deputy problem when setting priorities/mcps.
 2018-02-26 11:24:22 +11:00
Kofi Doku Atuah
8e7f9fbbab Manual: Correction of the name of the Zynq board 2018-02-08 15:13:11 +11:00
Kofi Doku Atuah
e2c7814017 PR: Clarify which ODROID machine 2018-02-08 14:11:59 +11:00
Kofi Doku Atuah
6062e0dac1 CAMKES-637: Manual: Hardware debug API: Document supported platforms 
These are the platforms on which seL4test is able to successfully execute the
breakpoint tests.
 2018-02-07 15:20:40 +11:00
Hesham Almatary
a66feddb8c Manual: Delete a sentence that's not valid anymore 2017-10-24 15:09:16 +11:00
Adrian Danis
567127defe manual: Expand parts of the x86 virtualisation documentation 
This provides documentation for kernel design of the x86 virtualisation, the additional
syscall and object invocations. The ARM design is not fully expanded.
 2017-09-18 14:01:46 +10:00
Kent McLeod
76dd101fe1 manual: fix python script to be python3 compatible 2017-09-18 11:28:33 +10:00
Hesham Almatary
c1851e3f1c Manual: vspace.tex - document cache operations on page directories 2017-08-09 10:01:00 +10:00
Kent McLeod
d3e90341d6 manual: remove some unused tex commands 2017-06-29 12:06:39 +10:00
Kent McLeod
8e3598bdcf SELFOUR-912: migrate ARM docs from latex to xml 2017-06-29 12:06:39 +10:00
Anna Lyons
2a52a3f7c7 manual: remove some unused tex commands 2017-06-28 11:47:02 +10:00
Anna Lyons
422118c3e6 SELFOUR-913: migrate x86 docs from latex to xml 2017-06-28 11:47:00 +10:00
Anna Lyons
192a4162ee manual: allow non sec autorefs 
Previously anything in an autoref block was assumed to reference
a section, which isn't true. Change 'sec' to 'label' and move the
'sec' prefix into the label itself.
 2017-06-27 16:22:34 +10:00
Anna Lyons
40c61e5c18 Fix licenses (the rest) 2017-06-22 15:29:12 +10:00
Anna Lyons
adb7916041 manual: fix double escaping bug 2017-06-20 10:22:59 +10:00
Anna Lyons
cd9e1c9a39 manual: support for itemized lists 2017-06-19 14:43:54 +10:00
Anna Lyons
93d2ed6a77 manual: fix script licenses 2017-06-19 13:59:08 +10:00
Anna Lyons
4d7c272ba7 manual: appease pylint 2017-06-19 13:59:08 +10:00
Anna Lyons
b1ef79e32f manual: refactor + cleanup parse_doxygen_xml.py 
- use 'recursive=False' rather than 'content' to only search children
- use a parse table instead of if a long if/else
- fix nested lists
- use get_text from beautiful_soup rather than home brewed
- don't call latex_escape explicitly
 2017-06-19 13:59:08 +10:00
Anna Lyons
10801bd891 SELFOUR-962: allow API level description in manual 2017-06-19 13:59:08 +10:00
Anna Lyons
c6056ecbe9 SELFOUR-961: allow lists in API docs 
this change

- converts ordered doxygen lists to enumerate
- also wraps the benchmark config names in texttt
 2017-06-19 13:59:08 +10:00
Anna Lyons
6b69024674 manual: use BeautifulSoup in parse_doxygen_xml 
Use BeautifulSoup instead of minidom, for more powerful features
 2017-06-19 13:59:08 +10:00
Stephen Sherratt
8db82c2065 manual: Correct manual label for X86_Page_MapIO 2017-06-02 16:34:49 +10:00
Stephen Sherratt
e5c0d63c71 manual: Explicitly say TODO where doc is missing 2017-06-02 15:34:45 +10:00
Stephen Sherratt
0504785f98 manual: Variable for python interpreter 
This allows the manual to be built with `PYTHON=mypython make`, to
invoke the python scripts involved in generating documentation with a
particular version of python. The scripts are compatible with both
python2 and python3, but this should simplify debugging if this ever
stops being the case. If no value of PYTHON is specified, the default
value of "python" is used.
 2017-06-02 15:34:45 +10:00
Stephen Sherratt
e29b1e8fb0 manual: Docstrings for gen_invocations script 2017-06-02 15:34:45 +10:00
Stephen Sherratt
aee7a3cbc8 manual: Remove unused import 2017-06-02 15:34:45 +10:00
Stephen Sherratt
7ee77f2933 manual: Comments to docstrings 2017-06-02 15:34:45 +10:00
Stephen Sherratt
324d973dc1 manual: Suppress verbose output when building 2017-06-02 15:34:45 +10:00
Stephen Sherratt
748f571855 manual: Include prototypes for undocumented fns 2017-06-02 15:34:45 +10:00
Stephen Sherratt
fee7c9bd0d manual: More robust hanlding of xml errors 
When generating latex from doxygen-generated xml, if an expected element
is not found in the xml, raise a meaningful exception.
 2017-06-02 15:34:45 +10:00
Stephen Sherratt
d8e6a00115 manual: Improve handling of return type docs 
If no documentation is provided for the return value of a function, the
documentation generator will attempt to infer the documentation based on
the return type.
 2017-06-02 15:34:45 +10:00
Stephen Sherratt
32af54221f manual: Docs for debugg and benchmark syscalls 2017-06-02 15:34:45 +10:00
Stephen Sherratt
c4500519a5 manual: Less fragile handling of arch types 2017-06-02 15:34:45 +10:00
Stephen Sherratt
5cf5b16594 manual: Correct ia32 to x86 in some sections 2017-06-02 15:34:45 +10:00
Stephen Sherratt
3f2f66de2a manual: Use generated api docs in manual 2017-06-02 15:34:45 +10:00
Stephen Sherratt
e426676c63 manual: Handle case where api has no methods 2017-06-02 15:34:45 +10:00
Stephen Sherratt
3180e8ab53 manual: Validate interface files against dtd 2017-06-02 15:34:45 +10:00
Stephen Sherratt
9f891ab7df manual: Generate sections for arch-specific calls 
This just creates the sections with appropriate names and function
prototypes, with no textual description of what the functions do.
 2017-06-02 15:34:45 +10:00
Stephen Sherratt
58cbddecff manual: Parameterize \apidoc cmd with section type 2017-06-02 15:34:45 +10:00
Stephen Sherratt
ef74899681 manual: Docstring for gen_invocations stript 2017-05-23 16:27:09 +10:00
Stephen Sherratt
b2c84ed806 manual: Build system compatible with python3 2017-05-23 16:27:01 +10:00
Adrian Danis
133883c004 manual: Correct underscore 2017-05-22 14:32:06 +10:00
Corey Richardson
95be1939d3
manual: clarify that extraLen is in bytes 2017-05-18 13:32:21 -04:00
Corey Richardson
c0667b48a6
Fix note about numIOPTLevels 2017-05-18 13:30:02 -04:00
Adrian Danis
ddc58f3f82 manual: document bootinfo register 2017-03-08 09:25:47 +11:00
Adrian Danis
099b45074f libsel4: Deprecate bootinfo management 2017-03-08 09:25:47 +11:00
Adrian Danis
7836f76cf9 Extend bootinfo to support potentially arbitrary additional structures 
This provides a future proof interface for extending the bootinfo region with additional
kinds of optional architecture and platform specific information. The basic idea is to
report the size of a region directly following the bootinfo frame, which is made up of
a series of 'chunks'. Each chunk has an identifier (describing what it is) and a length,
allowing unknown chunks to be skipped in favor of examining the remaining of the chunks.
 2017-02-16 14:34:52 +11:00
Adrian Danis
1ec4128baa manual: Brief description of ARM ioSpaceCaps 2017-02-16 11:37:45 +11:00