linux.git/Documentation/kref.txt, branch master

docs: move the kref doc into the core-api book

2020-05-15T18:02:19+00:00

This document covers core kernel objects. So, add it into the core-api
book.

Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/f385af13b4a6d3ff8c89beedd4506900e79ca72e.1588345503.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet

docs: kref: Clarify the use of two kref_put() in example code

2020-02-25T10:39:10+00:00

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 
Signed-off-by: Jonathan Corbet

kref.txt: standardize document format

2017-07-14T19:51:45+00:00

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 
Signed-off-by: Jonathan Corbet

Revert "kref: double kref_put() in my_data_handler()"

2017-04-08T16:38:10+00:00

This reverts commit 8f1ecc9fbc5b223e4f5d5bb8bcd6f5672c4bc4b6.

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 
Cc: Roel Kluin 
Cc: Randy Dunlap 
Cc: KrishnamRaju raju 
Signed-off-by: Thomas Hellstrom 
Signed-off-by: Greg Kroah-Hartman

kref: Add kref_get_unless_zero documentation

2012-11-28T08:36:06+00:00

Document how kref_get_unless_zero should be used and how it helps
solve a typical kref / locking problem.

Signed-off-by: Thomas Hellstrom 
Signed-off-by: Dave Airlie

kref: Fix typo in kref documentation

2011-03-07T21:20:05+00:00

container_of() should refer to the struct created in the example.

Signed-off-by: Javi Merino 
Cc: Randy Dunlap 
Signed-off-by: Greg Kroah-Hartman

kref: double kref_put() in my_data_handler()

2009-09-18T16:48:52+00:00

The kref_put() already occurs after the out label

Signed-off-by: Roel Kluin 
Signed-off-by: Randy Dunlap 
Signed-off-by: Linus Torvalds

docs: convert kref semaphore to mutex

2008-02-06T18:41:09+00:00

Just converting this documentation semaphore reference, since we don't
want to promote semaphore usage.

Signed-off-by: Daniel Walker 
Acked-by: Corey Minyard 
Cc: Greg KH 
Signed-off-by: Andrew Morton 
Signed-off-by: Linus Torvalds

Fix wrong identifier name in Documentation/kref.txt

2007-05-11T17:07:14+00:00

There's a typo / wrong identifier name in Documentation/kref.txt. Fix it.

Signed-off-by: Satyam Sharma 
Acked-by: Corey Minyard 
Signed-off-by: Adrian Bunk

[PATCH] kref: add link to original documentation to the kref documentation.

2005-04-19T04:57:30+00:00

Signed-off-by: Greg Kroah-Hartman