xfs
[Top] [All Lists]

Re: [PATCH 6/6] xfs: document log sysfs attributes in testing ABI

To: Brian Foster <bfoster@xxxxxxxxxx>
Subject: Re: [PATCH 6/6] xfs: document log sysfs attributes in testing ABI
From: Dave Chinner <david@xxxxxxxxxxxxx>
Date: Thu, 26 Jun 2014 15:03:45 +1000
Cc: xfs@xxxxxxxxxxx
Delivered-to: xfs@xxxxxxxxxxx
In-reply-to: <1402060414-22075-7-git-send-email-bfoster@xxxxxxxxxx>
References: <1402060414-22075-1-git-send-email-bfoster@xxxxxxxxxx> <1402060414-22075-7-git-send-email-bfoster@xxxxxxxxxx>
User-agent: Mutt/1.5.21 (2010-09-15)
On Fri, Jun 06, 2014 at 09:13:34AM -0400, Brian Foster wrote:
> Create a sysfs-fs-xfs ABI documentation file for newly added sysfs
> attributes. This is created under the testing section.
> 
> Signed-off-by: Brian Foster <bfoster@xxxxxxxxxx>

Looks fine, but I'm not sure we ever want people to think these are
going to form part of the stable XFS ABI - they are encodings of
deeply internal functionality of XFS. We're not going to be tied to
an implementation because of diagnostic information we expose to
to sysfs, so users need to know that this is a volatile interface.

Hence I'd suggest adding a disclaimer indicating that these not ever
guaranteed to be stable and could change or be removed at any time
without warning. Say, for example, we add another description line
like this:

   Stability:           Volatile

We can then point out the entries that are we'll never guarantee are
stable, those that we are stabilising, and those that are considered
stable easily?

Cheers,

Dave.
-- 
Dave Chinner
david@xxxxxxxxxxxxx

<Prev in Thread] Current Thread [Next in Thread>