43 Commits

Author SHA1 Message Date
Jeremy Linton
943f198ebf documentation: Replace project name with Vectorscan and general updates
The generated documentation continues to refer to Hyperscan
despite the project now being VectorScan. Lets replace many
of the Hyperscan references with Vectorscan.

At the same time, lets resync the documentation here with the
vectorscan readme. This updates the supported platforms/compilers
and build options.

Signed-off-by: Jeremy Linton <jeremy.linton@arm.com>
2024-03-07 17:55:47 -06:00
Jeremy Linton
2d23d24b67 documentation: Update project name and copyright
The project name in the documentation should probably
be updated to reflect that this is vectorscan. Update
the copyright too.

Signed-off-by: Jeremy Linton <jeremy.linton@arm.com>
2024-03-07 17:55:47 -06:00
Jeremy Linton
d9a75dc3b9 documentation: Add cmake option to build man pages
Man pages tend to be preferred in some circles, lets add an
option to build the vectorscan documentation that way.

Signed-off-by: Jeremy Linton <jeremy.linton@arm.com>
2024-03-07 17:55:47 -06:00
Piotr Skamruk
6fd77679d9 [dev-reference] Fix minor typo in docs 2021-01-25 14:13:13 +02:00
Walt Stoneburner
345446519b Fixed several typos
Fixed spellings of regular, interpretation, and grammar to improve readability.

Fixes github issue #242
2021-01-25 14:13:13 +02:00
Wang Xiang W
beaca7c7db Adjust sensitive terms 2021-01-25 14:13:13 +02:00
Chang, Harry
b19a41528a Add cpu feature / target info "AVX512VBMI". 2021-01-25 14:13:13 +02:00
Hong, Yang A
765b8f9fb9 literal API: remove HS_FLAG_MULTILINE flag support
fixes github issue #237
2020-05-25 13:47:53 +00:00
Hong, Yang A
22991f2da1 update description of HS_FLAG_SOM_LEFTMOST to eliminate ambiguity 2020-05-25 13:47:53 +00:00
flip111
7b406c647c Update compilation.rst
fixed two spelling mistakes
2020-01-15 15:40:10 +00:00
Frank Wessels
edb3f8c51e Fix small typo 2019-12-02 16:37:43 +00:00
Chang, Harry
bc80eef39f Doc changes in "pure negative" logical combination support. 2019-10-30 15:19:19 +00:00
Hong, Yang A
435cd23823 Literal API: update dev-reference 2019-08-13 14:52:03 +08:00
Wang, Xiang W
35060958e4 doc: fix github repo address 2019-01-21 09:58:26 +08:00
Chang, Harry
f13cbd692e Update PCRE version to 8.42 (8.41 is also compatible) 2019-01-21 09:56:50 +08:00
Wang, Xiang W
746d1eafe5 chimera: update dev-reference 2018-07-09 12:10:37 -04:00
Lu, Qi
1ad2f8760c Windows porting: update docs. 2018-07-09 11:45:39 -04:00
Chang, Harry
8a1c497f44 Logical Combination of patterns. 2018-06-27 14:04:57 +08:00
Justin Viiret
b77c1ef411 doc: describe tools hscheck, hscollider, hsdump 2018-01-24 01:51:55 -05:00
Justin Viiret
efd76cb5c5 doc: in dev guide, avoid Goudy Old Style font 2018-01-24 01:51:45 -05:00
Justin Viiret
2e3c676194 doc: update copyright dates for 2018 2018-01-24 01:51:17 -05:00
Justin Viiret
1450dc9993 doc: remove stray '+' 2018-01-19 06:21:41 -05:00
Justin Viiret
d926e56a48 doc: make Wikipedia hyperlinks anonymous 2018-01-19 06:18:01 -05:00
Justin Viiret
ef7d920f79 doc: make doxygen filter out HS_CDECL 2018-01-19 06:17:43 -05:00
Justin Viiret
f9af9f85b2 doc: clarify description of streaming API 2018-01-19 06:16:59 -05:00
Matthew Barr
1891f14755 Add support for Hamming distance approx matching 2018-01-19 06:11:43 -05:00
Matthew Barr
aff7242ad3 Migrated from github.com/01org to github.com/intel 2017-10-26 09:40:40 +11:00
Matthew Barr
7192d47517 Update PCRE version to 8.41 2017-09-18 13:25:32 +10:00
Alex Coyte
7b17f0eed7 dev reference documentation for stream compression 2017-08-21 11:19:11 +10:00
Matthew Barr
9ce0abe0ff Docs: avx512 support 2017-06-09 10:12:02 +10:00
Justin Viiret
bfcb391580 doc: update copyright year 2017-04-26 15:36:04 +10:00
Justin Viiret
6dc1e202b9 hsbench: documentation 2017-04-26 15:34:45 +10:00
Anatoly Burakov
eed2743d04 Add approximate matching documentation 2017-04-26 15:15:50 +10:00
Matthew Barr
2bb0295c50 PCRE version updated to 8.40 2017-04-26 14:43:28 +10:00
Matthew Barr
c6e28567c1 Documentation updates for the fat runtime 2017-01-20 14:15:53 +11:00
Justin Viiret
d7466ff840 docs: more detail on option setting 2016-06-01 10:57:10 +10:00
Justin Viiret
428bb9a110 doc: correct syntax for "extended" option setting
Extended syntax (ignore whitespace) is controlled with (?x) and (?-x).
2016-06-01 10:57:10 +10:00
Justin Viiret
8f46b7cf2e doc: add description of serialization, runtime lib 2016-05-18 16:27:48 +10:00
Justin Viiret
3426bf57ec doc: clean up discussion of scratch space 2016-05-18 16:27:45 +10:00
Justin Viiret
b2ea641715 doc: update copyright dates 2016-05-18 16:27:42 +10:00
Justin Viiret
0f2cbb9ffd Small updates to documentation for 4.1 2015-12-18 14:36:53 +11:00
Matthew Barr
aafbd96a1d docs: describe BOOST_ROOT cmake variable 2015-10-30 11:28:38 +11:00
Matthew Barr
904e436f11 Initial commit of Hyperscan 2015-10-20 09:13:35 +11:00