Skip to content

Commit 3c58f15

Browse files
committed
Misc documentation tweaks
1 parent e4b6856 commit 3c58f15

File tree

4 files changed

+14
-41
lines changed

4 files changed

+14
-41
lines changed

LICENSE

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ it under the terms of the GNU General Public License as published by
1111
the Free Software Foundation; either version 3 of the License, or
1212
(at your option) any later version.
1313

14-
This program is distributed AS-IS, WITHOUT ANY WARRANTY, express or
14+
This program is distributed AS-IS, WITHOUT ANY WARRANTY, express or
1515
implied, including, but not limited to the WARRANTY OF MERCHANTABILITY
1616
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1717
for more details. The copyright holders hereby disclaim all warranties.
@@ -23,11 +23,11 @@ special, consequential, indirect or similar damages.
2323
You should have received a copy of the GNU General Public License
2424
along with this program; if not, write to the Free Software Foundation,
2525
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. On
26-
the initial date of release of this software, a copy can be found at
26+
the initial date of release of this software, a copy can be found at
2727
the following location:
2828

2929
https://www.gnu.org/licenses/gpl-3.0.en.html
3030

3131
If you have any questions, please contact:
32-
Eric Schulte or in writing at:
33-
GrammaTech, Inc., attn: Eric Schulte, 531 Esty Street, Ithaca, NY 14850
32+
Eric Schulte - [email protected] or in writing at:
33+
GrammaTech, Inc., attn: Eric Schulte, 531 Esty Street, Ithaca, NY 14850

README.md

+6-26
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,10 @@ The SOFTWARE-EVOLUTION-LIBRARY enables the programmatic modification
44
and evaluation of extant software.
55

66
A common interface abstracts over multiple types of software objects
7-
including abstract syntax trees parsed from source code, LLVM IR,
8-
compiled assembler, and linked ELF binaries. Mutation and evaluation
9-
methods are implemented on top of this interface supporting Search
10-
Based Software Engineering (SBSE) techniques.
7+
including abstract syntax trees parsed from source code (C/C++ support
8+
using Clang), compiled assembler, and linked ELF binaries. Mutation
9+
and evaluation methods are implemented on top of this interface
10+
supporting automation of common software engineering tasks through
11+
Search Based Software Engineering (SBSE) techniques.
1112

12-
This library has been used to optimize benchmark programs (see
13-
https://github.com/eschulte/goa) and to patch vulnerabilities in
14-
closed source binaries (see http://eschulte.github.io/netgear-repair).
15-
16-
See the info manual for more information. Available in the `doc/`
17-
directory and at http://GrammaTech.github.io/sel (*pending*).
18-
19-
Please cite Eric Schulte's Ph.D. dissertation when you publish results
20-
that you have obtained with the SOFTWARE-EVOLUTION-LIBRARY.
21-
22-
```bibtex
23-
@phdthesis{schulte2014dissertation,
24-
author = {Eric Schulte},
25-
title = {Neutral Networks of Real-World Programs and their
26-
Application to Automated Software Evolution},
27-
school = {University of New Mexico},
28-
address = {Albuquerque, USA},
29-
month = {July},
30-
year = {2014},
31-
note = {https://cs.unm.edu/~eschulte/dissertation}
32-
}
33-
```
13+
See the manual, available at http://GrammaTech.github.io/sel.

doc/sel-api.texi

+1-1
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ More information about the tokenizer component is provided in section
351351
@include include/fun-sel-mutant.texinfo
352352
@include include/fun-sel-pareto-selector.texinfo
353353
@c TEST SUITES @include include/fun-sel-process-exit-code.texinfo
354-
@include include/fun-sel-replace-fields-in-snippet.texinfo
354+
@c @include include/fun-sel-replace-fields-in-snippet.texinfo
355355
@include include/fun-sel-rinard.texinfo
356356
@include include/fun-sel-rinard-incremental.texinfo
357357
@include include/fun-sel-rinard-read-in.texinfo

doc/software-evolution-library.texi

+3-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
\Input texinfo
2-
@c @setfilename emacs-web-server.info
31
@documentencoding utf-8
42
@settitle Software Evolution Library
53

@@ -114,11 +112,6 @@ Mutation and evaluation methods (@pxref{Software Methods}) are
114112
implemented on top of this interface supporting Search Based Software
115113
Engineering (SBSE) techniques (@pxref{Search Functions}).
116114

117-
This library has been used to optimize benchmark programs (see
118-
@url{https://github.com/eschulte/goa}) and to patch vulnerabilities in
119-
closed source binaries (see
120-
@url{http://eschulte.github.io/netgear-repair}).
121-
122115

123116
@section How is it used?
124117

@@ -198,8 +191,8 @@ evolutionary search and automated software manipulation.
198191
@itemize
199192

200193
@item
201-
Multiple evolution techniques including generational or Monte Carlo
202-
Markov chain.
194+
Multiple search techniques including steady-state and generational
195+
evolution or Markov chain Monte Carlo (MCMC).
203196

204197
@item
205198
New mutations tailored to each software object.
@@ -648,7 +641,7 @@ natural selection.
648641

649642
@anchor{mcmc}
650643
@defun mcmc original test &key accept-fn max-evals max-time target period period-fn every-fn filter
651-
Preform Markov chain Monte Carlo search from the supplied
644+
Perform Markov chain Monte Carlo search from the supplied
652645
@code{ORIGINAL} software object using the supplied @code{TEST}
653646
function to evaluate the fitness of software objects. The fitness
654647
returned by the @code{test} function is optimized.

0 commit comments

Comments
 (0)