From cd6f9558d85c9f635985005e32123603de67f550 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Reynir=20Bj=C3=B6rnsson?= Date: Wed, 16 Mar 2022 17:32:19 +0000 Subject: [PATCH] Update solo5-elftool doc to 0.3.1. --- doc/index.html | 2 +- doc/odoc.css | 35 ++++++++++--------- .../Solo5_elftool/{.dune-keep => .dummy} | 0 doc/solo5-elftool/Solo5_elftool/index.html | 2 +- doc/solo5-elftool/index.html | 2 +- 5 files changed, 21 insertions(+), 20 deletions(-) rename doc/solo5-elftool/Solo5_elftool/{.dune-keep => .dummy} (100%) diff --git a/doc/index.html b/doc/index.html index 20fb07c..0380b32 100644 --- a/doc/index.html +++ b/doc/index.html @@ -11,7 +11,7 @@

OCaml package documentation

    -
  1. solo5-elftool 0.3.0
    2. +
  2. solo5-elftool 0.3.1
diff --git a/doc/odoc.css b/doc/odoc.css index c5d2acb..5362774 100644 --- a/doc/odoc.css +++ b/doc/odoc.css @@ -1,7 +1,7 @@ @charset "UTF-8"; /* Copyright (c) 2016 The odoc contributors. All rights reserved. Distributed under the ISC license, see terms at the end of the file. - odoc 2.0.2 */ + odoc 2.1.0 */ /* Fonts */ @import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500'); @@ -124,7 +124,6 @@ /* Reset a few things. */ html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video { - margin: 0; padding: 0; border: 0; font: inherit; @@ -153,7 +152,7 @@ body { } body { - max-width: 90ex; + max-width: 100ex; margin-left: calc(10vw + 20ex); margin-right: 4ex; margin-top: 20px; @@ -202,15 +201,6 @@ sup, sub { margin-left: 0.2ex; } -pre { - margin-top: 0.8em; - margin-bottom: 1.2em; -} - -p, ul, ol { - margin-top: 0.5em; - margin-bottom: 1em; -} ul, ol { list-style-position: outside } @@ -306,7 +296,6 @@ a.anchor { h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 { font-family: "Fira Sans", Helvetica, Arial, sans-serif; font-weight: 400; - margin: 0.5em 0 0.5em 0; padding-top: 0.1em; line-height: 1.2; overflow-wrap: break-word; @@ -315,7 +304,6 @@ h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 { h1 { font-weight: 500; font-size: 2.441em; - margin-top: 1.214em; } h1 { @@ -403,6 +391,10 @@ p a > code { color: var(--link-color); } +code { + white-space: pre-wrap; +} + /* Code blocks (e.g. Examples) */ pre code { @@ -427,8 +419,13 @@ pre code { padding: 0.35em 0.5em; } -div.spec, .def-doc { - margin-bottom: 20px; +.def-doc { + margin-bottom: 10px; +} + +/* Spacing between items */ +div.odoc-spec,.odoc-include { + margin-bottom: 2em; } .spec.type .variant { @@ -467,6 +464,10 @@ div.def-doc>*:first-child { position: relative; } +.odoc-include.shadowed-include { + display: none; +} + .odoc-include details:after { z-index: -100; display: block; @@ -483,7 +484,7 @@ div.def-doc>*:first-child { .odoc-include summary { position: relative; - margin-bottom: 20px; + margin-bottom: 1em; cursor: pointer; outline: none; } diff --git a/doc/solo5-elftool/Solo5_elftool/.dune-keep b/doc/solo5-elftool/Solo5_elftool/.dummy similarity index 100% rename from doc/solo5-elftool/Solo5_elftool/.dune-keep rename to doc/solo5-elftool/Solo5_elftool/.dummy diff --git a/doc/solo5-elftool/Solo5_elftool/index.html b/doc/solo5-elftool/Solo5_elftool/index.html index 8129192..d2dc8b5 100644 --- a/doc/solo5-elftool/Solo5_elftool/index.html +++ b/doc/solo5-elftool/Solo5_elftool/index.html @@ -1,2 +1,2 @@ -Solo5_elftool (solo5-elftool.Solo5_elftool)

Module Solo5_elftool

type mft_entry =
| Dev_block_basic of string
| Dev_net_basic of string

An entry in the manifest representing a device.

type mft = {
version : int;(*

version is at the moment always 1.

*)
entries : mft_entry list;(*

entries in the manifest.

*)
}

The Solo5 manifest

type abi_target =
| Hvt
| Spt
| Virtio
| Muen
| Genode
| Xen

The known solo5 targets

type abi = {
target : abi_target;(*

abi target

*)
version : int32;(*

abi version

*)
}

abi taget and abi version

val pp_mft_entry : Stdlib.Format.formatter -> mft_entry -> unit
val pp_mft : Stdlib.Format.formatter -> mft -> unit

Pretty-prints the manifest as JSON in a similar style as the Solo5 command * line tool 

solo5-elftool query-manifest

.

val pp_abi_target : Stdlib.Format.formatter -> abi_target -> unit
val pp_abi : Stdlib.Format.formatter -> abi -> unit

Pretty-prints the manifest as JSON in a similar style as the Solo5 command * line tool 

solo5-elftool query-abi

.

val query_manifest : Owee_buf.t -> (mft, [> `Msg of string ]) Stdlib.result

query_manifest buf is the solo5 manifest of buf, or an error message.

val query_abi : Owee_buf.t -> (abi, [> `Msg of string ]) Stdlib.result

query_abi buf is the solo5 abi of buf, or an error message.

\ No newline at end of file +Solo5_elftool (solo5-elftool.Solo5_elftool)

Module Solo5_elftool

type mft_entry =
| Dev_block_basic of string
| Dev_net_basic of string

An entry in the manifest representing a device.

type mft = {
version : int;(*

version is at the moment always 1.

*)
entries : mft_entry list;(*

entries in the manifest.

*)
}

The Solo5 manifest

type abi_target =
| Hvt
| Spt
| Virtio
| Muen
| Genode
| Xen

The known solo5 targets

type abi = {
target : abi_target;(*

abi target

*)
version : int32;(*

abi version

*)
}

abi taget and abi version

val pp_mft_entry : Stdlib.Format.formatter -> mft_entry -> unit
val pp_mft : Stdlib.Format.formatter -> mft -> unit

Pretty-prints the manifest as JSON in a similar style as the Solo5 command * line tool 

solo5-elftool query-manifest

.

val pp_abi_target : Stdlib.Format.formatter -> abi_target -> unit
val pp_abi : Stdlib.Format.formatter -> abi -> unit

Pretty-prints the manifest as JSON in a similar style as the Solo5 command * line tool 

solo5-elftool query-abi

.

val query_manifest : Owee_buf.t -> ( mft, [> `Msg of string ] ) Stdlib.result

query_manifest buf is the solo5 manifest of buf, or an error message.

val query_abi : Owee_buf.t -> ( abi, [> `Msg of string ] ) Stdlib.result

query_abi buf is the solo5 abi of buf, or an error message.

\ No newline at end of file diff --git a/doc/solo5-elftool/index.html b/doc/solo5-elftool/index.html index f21fead..ab191c3 100644 --- a/doc/solo5-elftool/index.html +++ b/doc/solo5-elftool/index.html @@ -1,2 +1,2 @@ -index (solo5-elftool.index)

solo5-elftool index

Library solo5-elftool

The entry point of this library is the module: Solo5_elftool.

\ No newline at end of file +index (solo5-elftool.index)

solo5-elftool index

Library solo5-elftool

The entry point of this library is the module: Solo5_elftool.

\ No newline at end of file