LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Vivien Didelot <vivien.didelot@savoirfairelinux.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Guenter Roeck <linux@roeck-us.net>,
	linux-kernel@vger.kernel.org, kernel@savoirfairelinux.com
Subject: [PATCH v2 3/3] sysfs: Document struct attribute_group
Date: Wed, 11 Mar 2015 14:22:11 -0400	[thread overview]
Message-ID: <1426098131-20106-4-git-send-email-vivien.didelot@savoirfairelinux.com> (raw)
In-Reply-To: <1426098131-20106-1-git-send-email-vivien.didelot@savoirfairelinux.com>

From: Guenter Roeck <linux@roeck-us.net>

Document variables defined in struct attribute_group to ensure
correct usage.

Signed-off-by: Guenter Roeck <linux@roeck-us.net>
---
 include/linux/sysfs.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/include/linux/sysfs.h b/include/linux/sysfs.h
index ddad161..99382c0 100644
--- a/include/linux/sysfs.h
+++ b/include/linux/sysfs.h
@@ -57,6 +57,21 @@ do {							\
 #define sysfs_attr_init(attr) do {} while (0)
 #endif
 
+/**
+ * struct attribute_group - data structure used to declare an attribute group.
+ * @name:	Optional: Attribute group name
+ *		If specified, the attribute group will be created in
+ *		a new subdirectory with this name.
+ * @is_visible:	Optional: Function to return permissions associated with an
+ *		attribute of the group. Will be called repeatedly for each
+ *		attribute in the group. Only read/write permissions as well as
+ *		SYSFS_PREALLOC are accepted. Must return 0 if an attribute is
+ *		not visible. The returned value will replace static permissions
+ *		defined in struct attribute or struct bin_attribute.
+ * @attrs:	Pointer to NULL terminated list of attributes.
+ * @bin_attrs:	Pointer to NULL terminated list of binary attributes.
+ *		Either attrs or bin_attrs or both must be provided.
+ */
 struct attribute_group {
 	const char		*name;
 	umode_t			(*is_visible)(struct kobject *,
-- 
2.3.2


  parent reply	other threads:[~2015-03-11 18:29 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-11 18:22 [PATCH v2 0/3] sysfs: Refine is_visible API Vivien Didelot
2015-03-11 18:22 ` [PATCH v2 1/3] sysfs: Use only return value from is_visible for the file mode Vivien Didelot
2015-03-12 10:00   ` Greg Kroah-Hartman
2015-03-11 18:22 ` [PATCH v2 2/3] sysfs: Only accept read/write permissions for file attributes Vivien Didelot
2015-03-12  1:33   ` Guenter Roeck
2015-03-12 10:01   ` Greg Kroah-Hartman
2015-03-12 10:39     ` Guenter Roeck
2015-03-12 13:43       ` Vivien Didelot
2015-03-12 13:49       ` Greg Kroah-Hartman
2015-03-11 18:22 ` Vivien Didelot [this message]
2015-03-12 10:00   ` [PATCH v2 3/3] sysfs: Document struct attribute_group Greg Kroah-Hartman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1426098131-20106-4-git-send-email-vivien.didelot@savoirfairelinux.com \
    --to=vivien.didelot@savoirfairelinux.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=kernel@savoirfairelinux.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --subject='Re: [PATCH v2 3/3] sysfs: Document struct attribute_group' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).