Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(1407)

Unified Diff: doc/manual/source/new-modules.rst

Issue 343030043: More flexible create-module.py and contrib/wscript
Patch Set: Revised patch Created 5 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « doc/manual/source/how-to-write-tests.rst ('k') | utils/create-module.py » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: doc/manual/source/new-modules.rst
===================================================================
--- a/doc/manual/source/new-modules.rst
+++ b/doc/manual/source/new-modules.rst
@@ -43,17 +43,24 @@
Step 1 - Create a Module Skeleton
*********************************
-A python program is provided in the source directory that
+A python program is provided in the ``utils`` directory that
will create a skeleton for a new module. For the purposes
of this discussion we will assume that your new module
-is called ``new-module``. From the ``src`` directory, do the following
+is called ``new-module``. From the top directory, do the following
to create the new module:
.. sourcecode:: bash
- $ ./create-module.py new-module
+ $ ./utils/create-module.py new-module
+
+By default ``create-module.py`` creates the module skeleton in the
+``src`` directory. However, it can also create modules in ``contrib``:
-Next, ``cd`` into ``new-module``; you will find this directory layout:
+.. sourcecode:: bash
+ $ ./utils/create-module.py contrib/new-contrib
+
+Let's assume we've created our new module in ``src``.
+``cd`` into ``src/new-module``; you will find this directory layout:
.. sourcecode:: text
« no previous file with comments | « doc/manual/source/how-to-write-tests.rst ('k') | utils/create-module.py » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b