Skip to content

Commit 211fafd

Browse files
committed
doc: refresh the General questions in the FAQ
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent 38ae20e commit 211fafd

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

doc/source/FAQ.rst

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -185,51 +185,51 @@ Otherwise, you can load the TclX library package for your OS and the ``configure
185185
(tclExtend.h,...) [[none]]
186186

187187

188-
Meta Information
189-
----------------
188+
General information
189+
-------------------
190190

191-
Why does *modules* use Tcl?
192-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
191+
Why does Modules use Tcl?
192+
^^^^^^^^^^^^^^^^^^^^^^^^^
193193

194-
The first versions of the *Modules* package used shell scripts to do its magic. The original authors then chose to implement the same in C to speed things up and to add features. At the time the only easily embeddable interpreter was Tcl which provided a standard language and the glue. Now that other interpreters are available they could be embedded, but haven't so far. There is also a pure Tcl version available.
194+
The first versions of the *Modules* package used shell scripts to do its
195+
magic. The original authors then chose to implement the same in C to speed
196+
things up and to add features. At the time the only easily embeddable
197+
interpreter was Tcl which provided a standard language and the glue.
198+
199+
A pure Tcl version of the modulecmd script is available, and starting with
200+
Modules version 4, it became the default implementation. The use of Tcl for
201+
both the core commands and modulefile interpretation simplifies the addition
202+
of new features.
195203

196204
How can I help?
197205
^^^^^^^^^^^^^^^
198206

199-
We can use help at various levels. The best way to contribute is to send in a patch file (see the FAQ on how to generate a patch file) with whatever fixes. The patch will be reviewed and tested. If you are a regular contributor then you'll likely be invited to become a developer and to have direct source access, and the fame, power, and prestige that all entails.
207+
See the :ref:`CONTRIBUTING` documentation. It provides guidelines on how to
208+
ask questions, report issues, submit patches.
200209

201210
How do I download the source repository?
202211
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
203212

204-
Anonymously clone the git repository, view the list of branches, and set to a specific branch:
213+
Anonymously clone the git repository:
205214

206215
.. code-block:: sh
207216
208-
git clone git://git.code.sf.net/p/modules/git modules-myversion
209-
cd modules-myversion
210-
git branch -a
211-
git checkout modules-3-X-Y
212-
git status
213-
214-
How do I generate a patch file?
215-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
216-
217-
If you're starting from a tarball
218-
"""""""""""""""""""""""""""""""""
217+
git clone https://github.com/envmodules/modules.git
219218
220-
Unpack the tarball and it should place the sources into a directory named modules-3.X.Y , then rename the directory to modules-3.X.Y-myversion or something like that. Make whatever changes you want, and be sure to test the changes and if you can add tests to identify the bug and the fix... that will endear yourself to the developers.
221-
222-
Once you have the changes in your version, then unpack the original sources from the tarball in a directory side-by-side to the directory with your version, and at that parent level run the following ``diff`` command:
219+
Then you can create a specific branch and start your local adaptation if any:
223220

224221
.. code-block:: sh
225222
226-
diff -u -r -P -N modules-3.X.Y modules-3.X.Y-myversion > my.patch
227-
228-
If you're starting from the git cloned repository:
229-
""""""""""""""""""""""""""""""""""""""""""""""""""
223+
cd modules
224+
git checkout -b my_work
230225
231-
From within the git repositories.
226+
I cannot find answer to my question
227+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
232228

233-
.. code-block:: sh
229+
If your question isn't answered in the :ref:`INSTALL` documentation or the
230+
:ref:`module(1)` and :ref:`modulefile(5)` man pages, you may also refer to the
231+
:ref:`cookbook` section, which offers various installation examples.
234232

235-
git diff > my.patch
233+
If you still can't find the information you need, consult the
234+
:ref:`CONTRIBUTING` documentation to learn how to ask your question within
235+
the Modules community.

0 commit comments

Comments
 (0)