[dm-devel] [PATCH] multipath-tools: add basic info on how to use multipath-tools with NVMe devices

[Martin Wilck]

On Thu, 2022-06-16 at 22:32 +0200, Xose Vazquez Perez wrote:
> On 4/1/22 12:20, Martin Wilck wrote:
> 
> > On Mon, 2022-03-28 at 19:57 +0200, Xose Vazquez Perez wrote:
> > > On 3/28/22 19:48, Martin Wilck wrote:
> > > > On Mon, 2022-03-28 at 19:04 +0200, Xose Vazquez Perez wrote:
> > > > > Cc: Martin Wilck <mwilck at suse.com>
> > > > > Cc: Benjamin Marzinski <bmarzins at redhat.com>
> > > > > Cc: Christophe Varoqui <christophe.varoqui at opensvc.com>
> > > > > Cc: DM-DEVEL ML <dm-devel at redhat.com>
> > > > > Signed-off-by: Xose Vazquez Perez <xose.vazquez at gmail.com>
> > > > > ---
> > > > >    README.nvme | 12 ++++++++++++
> > > > >    1 file changed, 12 insertions(+)
> > > > >    create mode 100644 README.nvme
> > > > 
> > > > Why another separate README with just 12 lines?
> > > > 
> > > > Martin
> > > 
> > > README.md is intended multipath-tools developers.
> > > And README.alua and README.nvme are for sysadmins.
> > > 
> > 
> > I see no fundamental reason not to merge all READMEs into one,
> > and create "sysadmin" and "developer" sections.
> 
> README.md is in markdown syntax.
> README.alua and README.nvme are plain text, and its content is easier
> to identify.
> Are you running out of inodes? :-)

No, it' about user friendliness. These .txt files are developer-level
documentation, while ALUA and NVMe are topic which are at least as
important to users as for developers. Distributions tend to ship the
READMEs under /usr/share/doc, but to be realistic, how many users still
look there for documentation these days?

Regards,
Martin