From 2d92dd9d40fa1918c8dfb7e3d4a0e7993bcd82fc Mon Sep 17 00:00:00 2001
From: Mehdi Achour <didou@php.net>
Date: Sun, 7 Jan 2007 02:39:58 +0000
Subject: [PATCH] Document the resources of CrackLib and the possible return
 values of crack_getlastmessage

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@226612 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../crack/functions/crack-getlastmessage.xml  | 55 ++++++++++++++++++-
 reference/crack/reference.xml                 |  7 ++-
 2 files changed, 58 insertions(+), 4 deletions(-)

diff --git a/reference/crack/functions/crack-getlastmessage.xml b/reference/crack/functions/crack-getlastmessage.xml
index 04428259f1..16000d245d 100644
--- a/reference/crack/functions/crack-getlastmessage.xml
+++ b/reference/crack/functions/crack-getlastmessage.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/crack.xml, last change in rev 1.1 -->
 <refentry id="function.crack-getlastmessage">
  <refnamediv>
@@ -21,7 +21,58 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   The message from the last obscure check.
+   The message from the last obscure check or &false; if there was no obscure
+   checks made so far.
+  </para>
+  <para>
+   The returned message is one of:
+   <itemizedlist>
+    <listitem>
+     <simpara>
+      <literal>it's WAY too short</literal>
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>it is too short</literal>
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>it does not contain enough DIFFERENT characters</literal>
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>it is all whitespace</literal>
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>it is too simplistic/systematic</literal>
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>it looks like a National Insurance number.</literal>
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>it is based on a dictionary word</literal>
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>it is based on a (reversed) dictionary word</literal>
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>strong password</literal>
+     </simpara>
+    </listitem>
+   </itemizedlist>
   </para>
  </refsect1>
  <refsect1 role="seealso">
diff --git a/reference/crack/reference.xml b/reference/crack/reference.xml
index 5847193e0e..5a6b4bbfe3 100644
--- a/reference/crack/reference.xml
+++ b/reference/crack/reference.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
 <!-- Purpose: mathcrypto.crypto -->
 <!-- Membership: pecl, external -->
 
@@ -38,7 +38,10 @@
 
    <section id="crack.resources">
     &reftitle.resources;
-    &no.resource;
+    <para>
+     The CrackLib extension defines a dictionary resource identifier returned
+     by <function>crack_opendict</function>.
+    </para>
    </section>
 
    <section id="crack.constants">