| Message ID | 20220709042037.21903-11-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Documentation: tdx: documentation fixes | expand |
On Sat, 2022-07-09 at 11:20 +0700, Bagas Sanjaya wrote: > kernel test robot reported htmldocs warning on Documentation/x86/tdx.rst: > > Documentation/x86/tdx.rst:69: WARNING: Unexpected indentation. > Documentation/x86/tdx.rst:70: WARNING: Block quote ends without a blank line; unexpected unindent. > > These warnings above are due to missing code block marker before TDX > initialization code, which confuses Sphinx as normal block quote instead. > > Add literal code block marker to fix the warnings. Thank you! will fix. > > Link: https://lore.kernel.org/linux-doc/202207042107.YqVvxdJz-lkp@intel.com/ > Fixes: f05f595045dfc7 ("Documentation/x86: Add documentation for TDX host support") > Reported-by: kernel test robot <lkp@intel.com> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> > --- > Documentation/x86/tdx.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/x86/tdx.rst b/Documentation/x86/tdx.rst > index 6c6b09ca6ba407..4430912a2e4f05 100644 > --- a/Documentation/x86/tdx.rst > +++ b/Documentation/x86/tdx.rst > @@ -62,7 +62,7 @@ use it as 'metadata' for the TDX memory. It also takes additional CPU > time to initialize those metadata along with the TDX module itself. Both > are not trivial. Current kernel doesn't choose to always initialize the > TDX module during kernel boot, but provides a function tdx_init() to > -allow the caller to initialize TDX when it truly wants to use TDX: > +allow the caller to initialize TDX when it truly wants to use TDX:: > > ret = tdx_init(); > if (ret)
diff --git a/Documentation/x86/tdx.rst b/Documentation/x86/tdx.rst index 6c6b09ca6ba407..4430912a2e4f05 100644 --- a/Documentation/x86/tdx.rst +++ b/Documentation/x86/tdx.rst @@ -62,7 +62,7 @@ use it as 'metadata' for the TDX memory. It also takes additional CPU time to initialize those metadata along with the TDX module itself. Both are not trivial. Current kernel doesn't choose to always initialize the TDX module during kernel boot, but provides a function tdx_init() to -allow the caller to initialize TDX when it truly wants to use TDX: +allow the caller to initialize TDX when it truly wants to use TDX:: ret = tdx_init(); if (ret)
kernel test robot reported htmldocs warning on Documentation/x86/tdx.rst: Documentation/x86/tdx.rst:69: WARNING: Unexpected indentation. Documentation/x86/tdx.rst:70: WARNING: Block quote ends without a blank line; unexpected unindent. These warnings above are due to missing code block marker before TDX initialization code, which confuses Sphinx as normal block quote instead. Add literal code block marker to fix the warnings. Link: https://lore.kernel.org/linux-doc/202207042107.YqVvxdJz-lkp@intel.com/ Fixes: f05f595045dfc7 ("Documentation/x86: Add documentation for TDX host support") Reported-by: kernel test robot <lkp@intel.com> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Documentation/x86/tdx.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)