| Message ID | 1526252999-13728-1-git-send-email-me@justinstandring.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series | doc: escape newlines in table cell with backslash | expand |
On 14/05/2018 01:09, Justin Standring wrote: > Ensure that the key words and names in tables aren't broken across new > lines when the tables are rendered. This makes it easier to search the > page for 'preserve-attributes', for example. > > Signed-off-by: Justin Standring <me@justinstandring.com> > --- > doc/source/sw-description.rst | 10 +++++----- > 1 file changed, 5 insertions(+), 5 deletions(-) > > diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst > index 2944d3d..2edf8d7 100644 > --- a/doc/source/sw-description.rst > +++ b/doc/source/sw-description.rst > @@ -861,7 +861,7 @@ There are 4 main sections inside sw-description: > | | | | "filesystem" type. (path is always | > | | | | relative to the mount point.) | > +-------------+----------+------------+---------------------------------------+ > - | preserve- | bool | files | flag to control whether the following | > + | preserve-\ | bool | files | flag to control whether the following | > | attributes | | | attributes will be preserved when | > | | | | files are unpacked from an archive | > | | | | (assuming destination filesystem | > @@ -878,7 +878,7 @@ There are 4 main sections inside sw-description: > | | | files | zlib-compressed and must be | > | | | | decompressed before being installed | > +-------------+----------+------------+---------------------------------------+ > - | installed- | bool | images | flag to indicate that image is | > + | installed-\ | bool | images | flag to indicate that image is | > | directly | | | streamed into the target without any | > | | | | temporary copy. Not all handlers | > | | | | support streaming. | > @@ -902,8 +902,8 @@ There are 4 main sections inside sw-description: > | description | string | | user-friendly description of the | > | | | | swupdate archive (any string) | > +-------------+----------+------------+---------------------------------------+ > - | install-if | bool | images | flag | > - | different | | files | if set, name and version are | > + | install-if\ | bool | images | flag | > + | -different | | files | if set, name and version are | > | | | | compared with the entries in | > +-------------+----------+------------+---------------------------------------+ > | encrypted | bool | images | flag | > @@ -919,7 +919,7 @@ There are 4 main sections inside sw-description: > | | | files | Used for verification of signed | > | | | scripts | images. | > +-------------+----------+------------+---------------------------------------+ > - | embedded- | string | | Lua code that is embedded in the | > + | embedded-\ | string | | Lua code that is embedded in the | > | script | | | sw-description file. | > +-------------+----------+------------+---------------------------------------+ > | offset | string | images | Optional destination offset | > Reviewed-by: Stefano Babic <sbabic@denx.de> Best regards, Stefano Babic
diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst index 2944d3d..2edf8d7 100644 --- a/doc/source/sw-description.rst +++ b/doc/source/sw-description.rst @@ -861,7 +861,7 @@ There are 4 main sections inside sw-description: | | | | "filesystem" type. (path is always | | | | | relative to the mount point.) | +-------------+----------+------------+---------------------------------------+ - | preserve- | bool | files | flag to control whether the following | + | preserve-\ | bool | files | flag to control whether the following | | attributes | | | attributes will be preserved when | | | | | files are unpacked from an archive | | | | | (assuming destination filesystem | @@ -878,7 +878,7 @@ There are 4 main sections inside sw-description: | | | files | zlib-compressed and must be | | | | | decompressed before being installed | +-------------+----------+------------+---------------------------------------+ - | installed- | bool | images | flag to indicate that image is | + | installed-\ | bool | images | flag to indicate that image is | | directly | | | streamed into the target without any | | | | | temporary copy. Not all handlers | | | | | support streaming. | @@ -902,8 +902,8 @@ There are 4 main sections inside sw-description: | description | string | | user-friendly description of the | | | | | swupdate archive (any string) | +-------------+----------+------------+---------------------------------------+ - | install-if | bool | images | flag | - | different | | files | if set, name and version are | + | install-if\ | bool | images | flag | + | -different | | files | if set, name and version are | | | | | compared with the entries in | +-------------+----------+------------+---------------------------------------+ | encrypted | bool | images | flag | @@ -919,7 +919,7 @@ There are 4 main sections inside sw-description: | | | files | Used for verification of signed | | | | scripts | images. | +-------------+----------+------------+---------------------------------------+ - | embedded- | string | | Lua code that is embedded in the | + | embedded-\ | string | | Lua code that is embedded in the | | script | | | sw-description file. | +-------------+----------+------------+---------------------------------------+ | offset | string | images | Optional destination offset |
Ensure that the key words and names in tables aren't broken across new lines when the tables are rendered. This makes it easier to search the page for 'preserve-attributes', for example. Signed-off-by: Justin Standring <me@justinstandring.com> --- doc/source/sw-description.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)