| Message ID | 20200214170833.25803-4-j.neuschaefer@gmx.net |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | [1/4] MAINTAINERS: Add ubifs-authentication.rst to UBIFS | expand |
On Fri, 14 Feb 2020 18:08:07 +0100 Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote: > This fixes the following warning: > > Documentation/filesystems/ubifs-authentication.rst:98: WARNING: > Inline interpreted text or phrase reference start-string without end-string. > > Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> So this, IMO, should be fixed in patch #2, when you're touching the file anyway. I don't see a lot of value in adding a warning to the docs build then immediately removing it. Also, please send a cover letter with multi-part sets like this so we know what the overall objective is. Note also that Mauro is also playing with this file (and ubifs.txt, which really should be included as well) at the same time. Thanks, jon
On Wed, Feb 19, 2020 at 04:17:58AM -0700, Jonathan Corbet wrote: > On Fri, 14 Feb 2020 18:08:07 +0100 > Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote: > > > This fixes the following warning: > > > > Documentation/filesystems/ubifs-authentication.rst:98: WARNING: > > Inline interpreted text or phrase reference start-string without end-string. > > > > Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> > > So this, IMO, should be fixed in patch #2, when you're touching the file > anyway. I don't see a lot of value in adding a warning to the docs build > then immediately removing it. Good point. > Also, please send a cover letter with multi-part sets like this so we > know what the overall objective is. Ok, I'll remember to do that more. In this case, I just saw this file and wanted it to work better with Sphinx. > Note also that Mauro is also playing with this file (and ubifs.txt, which > really should be included as well) at the same time. Hmm. I only saw Mauro's series after sending this one. I think I'll respin this series after Mauro's is merged, to keep the potential for merge conflicts low. Thanks, Jonathan Neuschäfer
diff --git a/Documentation/filesystems/ubifs-authentication.rst b/Documentation/filesystems/ubifs-authentication.rst index 12babb95a822..97f3780c2620 100644 --- a/Documentation/filesystems/ubifs-authentication.rst +++ b/Documentation/filesystems/ubifs-authentication.rst @@ -100,7 +100,7 @@ of nodes. Eg. data nodes (`struct ubifs_data_node`) which store chunks of file contents or inode nodes (`struct ubifs_ino_node`) which represent VFS inodes. Almost all types of nodes share a common header (`ubifs_ch`) containing basic information like node type, node length, a sequence number, etc. (see -`fs/ubifs/ubifs-media.h`in kernel source). Exceptions are entries of the LPT +`fs/ubifs/ubifs-media.h` in kernel source). Exceptions are entries of the LPT and some less important node types like padding nodes which are used to pad unusable content at the end of LEBs.
This fixes the following warning: Documentation/filesystems/ubifs-authentication.rst:98: WARNING: Inline interpreted text or phrase reference start-string without end-string. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> --- Documentation/filesystems/ubifs-authentication.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) -- 2.20.1