From: "Paul E. McKenney" <paulmck@xxxxxxxxxx> This commit moves the descriptions of the files residing in tools/memory-model/Documentation to a README file in that directory, leaving behind the description of tools/memory-model/Documentation/README itself. After this change, tools/memory-model/Documentation/README provides a guide to the files in the tools/memory-model/Documentation directory, guiding people with different skills and needs to the most appropriate starting point. Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxx> --- tools/memory-model/Documentation/README | 62 +++++++++++++++++++++++++++++++++ tools/memory-model/README | 22 ++---------- 2 files changed, 64 insertions(+), 20 deletions(-) create mode 100644 tools/memory-model/Documentation/README diff --git a/tools/memory-model/Documentation/README b/tools/memory-model/Documentation/README new file mode 100644 index 0000000..4326603 --- /dev/null +++ b/tools/memory-model/Documentation/README @@ -0,0 +1,62 @@ +This file serves as the guide for the other files residing in the +tools/memory-model/Documentation directory. It has been said that at +its best, communication involves identifying where the target audience +is and then building a bridge from where they are to where they need +to go. Unfortunately, this time-honored approach falls short in this +case because readers of the documents in this directory might be in any +number of places. + +This document therefore describes a number of places to start reading +the documentation in this directory, depending on what you know and what +you would like to learn: + +o You are new to Linux-kernel concurrency: simple.txt + +o You are familiar with the concurrency facilities that you + need, and just want to get started with LKMM litmus tests: + litmus-tests.txt + +o You are familiar with Linux-kernel concurrency, and would + like a detailed intuitive understanding of LKMM, including + situations involving more than two threads: recipes.txt + +o You are familiar with Linux-kernel concurrency and the + use of LKMM, and would like a cheat sheet to remind you + of LKMM's guarantees: cheatsheet.txt + +o You are familiar with Linux-kernel concurrency and the + use of LKMM, and would like to learn about LKMM's requirements, + rationale, and implementation: explanation.txt + +o You are interested in the publications related to LKMM, including + hardware manuals, academic literature, standards-committee working + papers, and LWN articles: references.txt + + +==================== +DESCRIPTION OF FILES +==================== + +Documentation/README + This file. + +Documentation/cheatsheet.txt + Quick-reference guide to the Linux-kernel memory model. + +Documentation/explanation.txt + Describes the memory model in detail. + +Documentation/litmus-tests.txt + Describes the format, features, capabilities, and limitations + of the litmus tests that LKMM can evaluate. + +Documentation/recipes.txt + Lists common memory-ordering patterns. + +Documentation/references.txt + Provides background reading. + +Documentation/simple.txt + Starting point for someone new to Linux-kernel concurrency. + And also for those needing a reminder of the simpler approaches + to concurrency! diff --git a/tools/memory-model/README b/tools/memory-model/README index c8144d4..39d08d1 100644 --- a/tools/memory-model/README +++ b/tools/memory-model/README @@ -161,26 +161,8 @@ running LKMM litmus tests. DESCRIPTION OF FILES ==================== -Documentation/cheatsheet.txt - Quick-reference guide to the Linux-kernel memory model. - -Documentation/explanation.txt - Describes the memory model in detail. - -Documentation/litmus-tests.txt - Describes the format, features, capabilities, and limitations - of the litmus tests that LKMM can evaluate. - -Documentation/recipes.txt - Lists common memory-ordering patterns. - -Documentation/references.txt - Provides background reading. - -Documentation/simple.txt - Starting point for someone new to Linux-kernel concurrency. - And also for those needing a reminder of the simpler approaches - to concurrency! +Documentation/README + Guide to the other documents in the Documentation/ directory. linux-kernel.bell Categorizes the relevant instructions, including memory -- 2.9.5
