Commit Graph

10 Commits

Author SHA1 Message Date
Manivannan Sadhasivam ef45e78fdc docs: kref: Clarify the use of two kref_put() in example code
Eventhough the current documentation explains that the reference count
gets incremented by both kref_init() and kref_get(), it is often
misunderstood that only one instance of kref_put() is needed in the
example code. So let's clarify that a bit.

Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-02-25 03:39:10 -07:00
Mauro Carvalho Chehab d6ac1c7e2f kref.txt: standardize document format
Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- add a title for the document and section titles;
- move authorship information to the beginning and use
  :Author:
- mark literal blocks as such and ident them if needed.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-14 13:51:45 -06:00
Thomas Hellstrom fd0f50db2e Revert "kref: double kref_put() in my_data_handler()"
This reverts commit 8f1ecc9fbc.

The correction is incorrect, see discussion at

http://stackoverflow.com/questions/20093127/why-kref-doc-of-linux-kernel-omits-kref-put-when-kthread-run-fail

Reported-by: KrishnamRaju raju <ekraju@gmail.com>
Cc: Roel Kluin <roel.kluin@gmail.com>
Cc: Randy Dunlap <randy.dunlap@oracle.com>
Cc: KrishnamRaju raju <ekraju@gmail.com>
Signed-off-by: Thomas Hellstrom <thellstrom@vmware.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-04-08 18:38:10 +02:00
Thomas Hellstrom a82b8db02f kref: Add kref_get_unless_zero documentation
Document how kref_get_unless_zero should be used and how it helps
solve a typical kref / locking problem.

Signed-off-by: Thomas Hellstrom <thellstrom@vmware.com>
Signed-off-by: Dave Airlie <airlied@redhat.com>
2012-11-28 18:36:06 +10:00
Javi Merino d5c97c1099 kref: Fix typo in kref documentation
container_of() should refer to the struct created in the example.

Signed-off-by: Javi Merino <cibervicho@gmail.com>
Cc: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2011-03-07 13:20:05 -08:00
Roel Kluin 8f1ecc9fbc kref: double kref_put() in my_data_handler()
The kref_put() already occurs after the out label

Signed-off-by: Roel Kluin <roel.kluin@gmail.com>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2009-09-18 09:48:52 -07:00
Daniel Walker 1373bed34e docs: convert kref semaphore to mutex
Just converting this documentation semaphore reference, since we don't
want to promote semaphore usage.

Signed-off-by: Daniel Walker <dwalker@mvista.com>
Acked-by: Corey Minyard <minyard@acm.org>
Cc: Greg KH <greg@kroah.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2008-02-06 10:41:09 -08:00
Satyam Sharma b7cc4a879c Fix wrong identifier name in Documentation/kref.txt
There's a typo / wrong identifier name in Documentation/kref.txt. Fix it.

Signed-off-by: Satyam Sharma <ssatyam@cse.iitk.ac.in>
Acked-by: Corey Minyard <minyard@acm.org>
Signed-off-by: Adrian Bunk <bunk@stusta.de>
2007-05-11 19:07:14 +02:00
gregkh@suse.de 6f31e42221 [PATCH] kref: add link to original documentation to the kref documentation.
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2005-04-18 21:57:30 -07:00
minyard@acm.org 5c11c52046 [PATCH] kref: add documentation
Add some documentation for krefs.

Signed-off-by: Corey Minyard <minyard@acm.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2005-04-18 21:57:30 -07:00