php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

ssdeep : fix XML by converting para to simpara tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-25 16:06:08 +00:00
parent 12f0e72200
commit 2885123b1a
6 changed files with 45 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
reference/ssdeep/book.xml
View File

@@ -1,25 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<book xml:id="book.ssdeep" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.ssdeep">
<?phpdoc extension-membership="pecl" ?>
<title>ssdeep Fuzzy Hashing</title>
<titleabbrev>ssdeep</titleabbrev>
<preface xml:id="intro.ssdeep">
&reftitle.intro;
<para>
<simpara>
ssdeep is a utility for creating and comparing fuzzy hashes or
<link xlink:href="&url.ssdeep.ctph;">context-triggered piecewise
hashing</link>.
</para>
<para>
</simpara>
<simpara>
Fuzzy hashing can match signatures which have "...sequences of identical
bytes in the same order, although bytes in between these sequences
may be different in both content and length" (<link xlink:href="&url.ssdeep.libssdeep;">
ssdeep project page</link>).
</para>
<para>
</simpara>
<simpara>
This extension provides functions for creating and comparing fuzzy hashes.
</para>
</simpara>
</preface>
&reference.ssdeep.setup;

9
reference/ssdeep/configure.xml
View File

@@ -1,17 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="ssdeep.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ssdeep.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;ssdeep">&url.pecl.package;ssdeep</link>
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/ssdeep/functions/ssdeep-fuzzy-compare.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ssdeep-fuzzy-compare" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssdeep-fuzzy-compare">
<refnamediv>
<refname>ssdeep_fuzzy_compare</refname>
<refpurpose>Calculates the match score between two fuzzy hash signatures</refpurpose>
@@ -14,12 +13,12 @@
<methodparam><type>string</type><parameter>signature1</parameter></methodparam>
<methodparam><type>string</type><parameter>signature2</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Calculates the match score between <parameter>signature1</parameter>
and <parameter>signature2</parameter> using <link xlink:href="&url.ssdeep.ctph;">
context-triggered piecewise hashing</link>, and returns the match
score.
</para>
</simpara>
</refsect1>
@@ -29,17 +28,17 @@
<varlistentry>
<term><parameter>signature1</parameter></term>
<listitem>
<para>
<simpara>
The first fuzzy hash signature string.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>signature2</parameter></term>
<listitem>
<para>
<simpara>
The second fuzzy hash signature string.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,14 +46,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an integer from 0 to 100 on success, &false; otherwise.
</para>
<simpara>
Returns an integer from 0 to 100 on success, &false; otherwise.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ssdeep-fuzzy-hash-filename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssdeep-fuzzy-hash-filename">
<refnamediv>
<refname>ssdeep_fuzzy_hash_filename</refname>
<refpurpose>Create a fuzzy hash from a file</refpurpose>
@@ -13,12 +12,12 @@
<type>string</type><methodname>ssdeep_fuzzy_hash_filename</methodname>
<methodparam><type>string</type><parameter>file_name</parameter></methodparam>
</methodsynopsis>
<para>
<function>ssdeep_fuzzy_hash_filename</function> calculates the hash
of the file specified by <parameter>file_name</parameter> using
<link xlink:href="&url.ssdeep.ctph;">context-triggered piecewise
<simpara>
<function>ssdeep_fuzzy_hash_filename</function> calculates the hash
of the file specified by <parameter>file_name</parameter> using
<link xlink:href="&url.ssdeep.ctph;">context-triggered piecewise
hashing</link>, and returns that hash.
</para>
</simpara>
</refsect1>
@@ -28,9 +27,9 @@
<varlistentry>
<term><parameter>file_name</parameter></term>
<listitem>
<para>
<simpara>
The filename of the file to hash.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,14 +37,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a string on success, &false; otherwise.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/ssdeep/functions/ssdeep-fuzzy-hash.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ssdeep-fuzzy-hash" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssdeep-fuzzy-hash">
<refnamediv>
<refname>ssdeep_fuzzy_hash</refname>
<refpurpose>Create a fuzzy hash from a string</refpurpose>
@@ -13,11 +12,11 @@
<type>string</type><methodname>ssdeep_fuzzy_hash</methodname>
<methodparam><type>string</type><parameter>to_hash</parameter></methodparam>
</methodsynopsis>
<para>
<function>ssdeep_fuzzy_hash</function> calculates the hash of
<simpara>
<function>ssdeep_fuzzy_hash</function> calculates the hash of
<parameter>to_hash</parameter> using <link xlink:href="&url.ssdeep.ctph;">
context-triggered piecewise hashing</link>, and returns that hash.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +25,9 @@
<varlistentry>
<term><parameter>to_hash</parameter></term>
<listitem>
<para>
<simpara>
The input string.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,14 +35,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a string on success, &false; otherwise.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/ssdeep/setup.xml
View File

@@ -1,29 +1,27 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="ssdeep.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ssdeep.setup">
&reftitle.setup;
<section xml:id="ssdeep.requirements">
&reftitle.required;
<para>
<simpara>
This extension requires the <link xlink:href="&url.ssdeep.libssdeep;">ssdeep</link> library.
</para>
</simpara>
</section>
<section xml:id="ssdeep.installation">
&reftitle.install;
<para>
<simpara>
&pecl.moved;
</para>
<para>
</simpara>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;ssdeep">&url.pecl.package;ssdeep</link>.
</para>
</simpara>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml