@@ -22,9 +22,9 @@ should do. Starting with seq-`2.2.6`_, EPICS 7 can be used.
2222re2c
2323^^^^
2424
25- Building the sequencer also requires the lexer generator tool ` re2c`_ . The
26- minimum version required is 0.9.9, but I recommend using the latest version
27- that is avaliable for your system. If you are building on a Linux system,
25+ Building the sequencer also requires the lexer generator tool re2c. The
26+ minimum version required is 0.9.9, but it is recommend to use the latest
27+ version avaliable for your system. If you are building on a Linux system,
2828you can use the re2c package your distribution provides.
2929
3030On Windows things are not quite as smooth. The `old re2c download`_ page on
@@ -55,9 +55,8 @@ a new release.
5555
5656.. note::
5757
58- The documentation and download links you will find on this page are for
59- version 2.2.
60-
58+ The documentation and download links you will find on this page
59+ mostly are for version 2.2, which is on GitHub.
6160
6261Here are all releases for version 2.2:
6362
@@ -75,22 +74,10 @@ Here are all releases for version 2.2:
7574 `2.2.1`_ `Release_Notes_2.2.1` `Known_Problems_2.2.1`
7675 ========== ======================= ============================
7776
78- If you want to help testing, please check out
79- the `darcs`_ repository for `branch-2-2`_::
80-
81- darcs get https://hub.darcs.net/bf/seq-branch-2-2
82-
83- Using this git mirror, you can as well ::
77+ If you want to help testing, please clone ::
8478
8579 git clone https://github.com/epics-modules/sequencer.git
8680
87- but please note that this is just a mirror: I cannot accept git
88- patches or work with GitHub Pull Requests; it may also happen that I have
89- to re-create the whole git repo from scratch (because incremental conversion
90- sometimes fails).
91-
92- Development of new features now happens on `branch-2-3`_.
93-
9481See `Contribute`_ for a short description how to record and send patches.
9582
9683.. _2.2.9: https://github.com/epics-modules/sequencer/releases/tag/R2-2-9
@@ -184,7 +171,7 @@ The html pages are generated by issuing::
184171 make html
185172
186173This will generate the home page and install it into the directory
187- ``$SEQ/html``. This step requires that you have ` Python`_ and ` Sphinx`_
174+ ``$SEQ/html``. This step requires that you have Python and Sphinx
188175installed on your system.
189176
190177If, in addition, you want a printable version (pdf), do::
@@ -291,7 +278,7 @@ into your Makefile. Here, ``xyz.st`` is the name of your SNL program, and
291278``abc`` is the name of the library or binary to produce. Note that ``.st``
292279files are run through the C preprocessor (`cpp`) before giving them to
293280the SNL compiler. Use the extension ``.stt`` to avoid this. For details,
294- see the `relevant part in the EPICS Application Developer's Guide
281+ see the `SNL part of the EPICS Application Developer's Guide
295282<https://docs.epics-controls.org/en/latest/build-system/specifications.html#state-notation-programs>`_.
296283
297284A complete example application that also uses the sequencer can be
@@ -305,64 +292,20 @@ Take a look at ``exApp/src``, especially the ``Makefile``.
305292Report Bugs
306293-----------
307294
308- Please send bug reports to to tech-talk@aps.anl.gov or the maintainer
309- (currently this is `me <benjamin.franksen@helmholtz-berlin.de>`_). It helps
310- if you include which release of the sequencer and EPICS base release
295+ Please file bug reports in the GitHub `issue tracker`_.
296+ It helps if you include which release of the sequencer and EPICS base release
311297you are using.
312298
299+ .. _issue tracker: https://github.com/epics-modules/sequencer/issues
313300
314301Contribute
315302----------
316303
317- I am always happy to receive patches (bug fixes, improvements, whatever).
318- For minor changes you don't need to bother with `darcs`_, just send me a
319- `patch file`_.
320-
321- .. _patch file: http://en.wikipedia.org/wiki/Patch_%28Unix%29
322-
323- For more involved changes you might want to send a `darcs`_ patch. You can
324- create a local copy of the `darcs`_ repository (the stable branch in this
325- example) by saying::
326-
327- darcs get https://hub.darcs.net/bf/seq-branch-2-2
328-
329- Assuming you have made some changes, first update your repository to
330- include the latest changes from upstream (with darcs this is not
331- strictly necessary, but good practice as it helps to avoid unnecessary
332- conflicts)::
333-
334- darcs pull
335-
336- (darcs will ask you for each patch that is not yet in your repo). Then
337- record your changes (if you haven't already)::
338-
339- darcs record
340-
341- (darcs will prompt you for every single change you made and then prompt
342- you for giving the patch a name). Finally say::
343-
344- darcs send
345-
346- A word of caution: it may happen that I `darcs obliterate`_ patches in
347- the experimental branch. If `darcs send`_ asks whether to include patches
348- that you don't have authored, this is probably what happened. In that case
349- can (but you need not necessarily) quit and obliterate them in your source
350- tree, too, before trying to `darcs send`_ again.
304+ Please prepare improvements and fixes as Pull Requests.
351305
352- Please respect the coding style when making changes. This includes
306+ Respect the coding style when making changes. This includes
353307indentation (tabs or spaces, how many) and all the other little things
354308on which programmers like to differ ;-) like placement of braces etc.
355- Note that for historical reasons the style differs somewhat between
356- files and subdirectories. It is much easier for me to review patches if
357- they do not contain gratuitous changes or combine several unrelated
358- changes in a single patch.
359-
360- Also, please take care that your patch does not accidentally contain
361- site-specific changes (typically done in configure). For my own work, I
362- usually record such changes with a description that contains 'DONT SEND
363- THIS' or something similar, so I don't accidentally record them together
364- with other changes.
365-
366- .. _darcs: http://darcs.net/
367- .. _darcs obliterate: http://darcs.net/manual/bigpage.html#SECTION00694000000000000000
368- .. _darcs send: http://darcs.net/manual/bigpage.html#SECTION00664000000000000000
309+ To make review easier, please avoid whitespace changes
310+ (or keep them in a separate commit)
311+ and do not combine several unrelated changes in a single commit.
0 commit comments