Re: [Qemu-devel] [PATCH] docs/nvdimm: add example on persistent backend setup

[Stefan Hajnoczi]

On Tue, Jul 30, 2019 at 1:52 AM Wei Yang <address@hidden> wrote:
>
> Hi, Stefan
>
> Thanks for your comments :-)
>
> On Mon, Jul 29, 2019 at 02:58:59PM +0100, Stefan Hajnoczi wrote:
> >On Wed, Jul 24, 2019 at 03:03:07PM +0800, Wei Yang wrote:
> >> Persistent backend setup requires some knowledge about nvdimm and ndctl
> >> tool. Some users report they may struggle to gather these knowledge and
> >> have difficulty to setup it properly.
> >>
> >> Here we provide two examples for persistent backend and gives the link
> >> to ndctl. By doing so, user could try it directly and do more
> >> investigation on persistent backend setup with ndctl.
> >>
> >> Signed-off-by: Wei Yang <address@hidden>
> >> ---
> >>  docs/nvdimm.txt | 28 ++++++++++++++++++++++++++++
> >>  1 file changed, 28 insertions(+)
> >>
> >> diff --git a/docs/nvdimm.txt b/docs/nvdimm.txt
> >> index b531cacd35..baba7a940d 100644
> >> --- a/docs/nvdimm.txt
> >> +++ b/docs/nvdimm.txt
> >> @@ -171,6 +171,32 @@ guest software that this vNVDIMM device contains a 
> >> region that cannot
> >>  accept persistent writes. In result, for example, the guest Linux
> >>  NVDIMM driver, marks such vNVDIMM device as read-only.
> >>
> >> +Backend File Setup Example
> >> +..........................
>
> Here I use '-' because I want to say this is a sub-section of "Guest Data
> Persistence".
>
> Actually, I struggled a little to pick up a proper character. Do you think '-'
> is the proper one?

This is a .txt file without syntax.  Whatever you choose might be
confusing to someone.  If you use a separate '-' section like the rest
of the document then that avoids confusion.

Stefan