Skip to contentSkip to conversation

docbook: duplicate kernel-locking doc merge

PATCH In review Randy Dunlap 3 participants 3 messages May 28, 2008 – May 29, 2008 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docbook: duplicate kernel-locking doc merge

From: Randy Dunlap <[email protected]>

Removed duplicated patch lines.

I was checking mmotm (2008-0527) kernel docs and got this error:

xmlto: input does not validate (status 3)
/local/linsrc/mmotm-2008-0527-0032/Documentation/DocBook/kernel-locking.xml:722: element chapter: validity error : ID trylock-functions already defined <chapter id="trylock-functions">

                               ^

/local/linsrc/mmotm-2008-0527-0032/Documentation/DocBook/kernel-locking.xml:722: element chapter: validity error : ID trylock-functions already defined Document /local/linsrc/mmotm-2008-0527-0032/Documentation/DocBook/kernel-locking.xml does not validate
make[1]: *** [Documentation/DocBook/kernel-locking.html] Error 3
make[1]: *** Waiting for unfinished jobs....
make: *** [htmldocs] Error 2

Looks like Rusty's doc additions were duplicated.

---
 Documentation/DocBook/kernel-locking.tmpl |   25 -------------------------
 1 file changed, 25 deletions(-)
Documentation/DocBook/kernel-locking.tmpl +0 -25
@@ -719,31 +719,6 @@
   </para>
 </chapter>
 
-<chapter id="trylock-functions">
- <title>The trylock Functions</title>
-  <para>
-   There are functions that try to acquire a lock only once and immediately
-   return a value telling about success or failure to acquire the lock.
-   They can be used if you need no access to the data protected with the lock
-   when some other thread is holding the lock. You should acquire the lock
-   later if you then need access to the data protected with the lock.
-  </para>
-
-  <para>
-    <function>spin_trylock()</function> does not spin but returns non-zero if
-    it acquires the spinlock on the first try or 0 if not. This function can
-    be used in all contexts like <function>spin_lock</function>: you must have
-    disabled the contexts that might interrupt you and acquire the spin lock.
-  </para>
-
-  <para>
-    <function>mutex_trylock()</function> does not suspend your task
-    but returns non-zero if it could lock the mutex on the first try
-    or 0 if not. This function cannot be safely used in hardware or software
-    interrupt contexts despite not sleeping.
-  </para>
-</chapter>
-
   <chapter id="Examples">
    <title>Common Examples</title>
     <para>
#1 lore raw
Quoted 10 lines · On Tue, 27 May 2008 22:13:27 -0700 Randy Dunlap <[email protected]> wrote:

From: Randy Dunlap <[email protected]>

Removed duplicated patch lines.

I was checking mmotm (2008-0527) kernel docs and got this error:

xmlto: input does not validate (status 3)
/local/linsrc/mmotm-2008-0527-0032/Documentation/DocBook/kernel-locking.xml:722: element chapter: validity error : ID trylock-functions already defined <chapter id="trylock-functions">

Quoted 8 lines
                               ^

/local/linsrc/mmotm-2008-0527-0032/Documentation/DocBook/kernel-locking.xml:722: element chapter: validity error : ID trylock-functions already defined Document /local/linsrc/mmotm-2008-0527-0032/Documentation/DocBook/kernel-locking.xml does not validate
make[1]: *** [Documentation/DocBook/kernel-locking.html] Error 3
make[1]: *** Waiting for unfinished jobs....
make: *** [htmldocs] Error 2

Looks like Rusty's doc additions were duplicated.

ah, thanks, that's me trying to pick up patches which aren't in linux-next yet. I normally don't bother doing that unless there's a lot of material involved.

I'll zap the erroneously-included rusty-misc-doc_add_a_chapter_about_trylock_functions_bug_9011.patch

#2 lore raw
Quoted 9 lines · On Wednesday 28 May 2008 15:14:19 Andrew Morton wrote:
Quoted 1 line · On Tue, 27 May 2008 22:13:27 -0700 Randy Dunlap <[email protected]> wrote:

Looks like Rusty's doc additions were duplicated.

ah, thanks, that's me trying to pick up patches which aren't in linux-next yet. I normally don't bother doing that unless there's a lot of material involved.

I'll zap the erroneously-included rusty-misc-doc_add_a_chapter_about_trylock_functions_bug_9011.patch

If it's any consolation, I too got confused when Linus merged that: the patch applies multiple times without fuzz. Impressive.

Cheers,
Rusty.