Refine pyarmor 9.1 docs

Author: jondy

pyarmor/docs/en/user/configuration.rst

@@ -88,42 +88,42 @@ Set option value. For example::
      - Bool
      - Recursively search modules and packages in project src
 
-Section: rft_option
--------------------
+Section: rft
+------------
 
 List all the options and values in this section::
 
-  $ pyarmor env -p info rft_option
+  $ pyarmor env -p info rft
 
-Get only one option value. For example, `rft_argument`::
+Get only one option value. For example, `enable_argument`::
 
-  $ pyarmor env -p get rft_option:rft_argument
+  $ pyarmor env -p get rft:enable_argument
 
 Set option value. For example::
 
-  $ pyarmor env -p set rft_option:rft_argument 0
+  $ pyarmor env -p set rft:enable_argument 0
 
-.. flat-table:: Table-4. Section `rft_option` Options
+.. flat-table:: Table-4. Section `rft` Options
    :widths: 20 10 10 60
    :header-rows: 1
 
    * - Option
      - Type
      - Default
      - Remark
-   * - rft_remove_assert
+   * - remove_assert
      - Bool
      - 0
      - Remove `assert` statement in the script
-   * - rft_remove_docstr
+   * - remove_docstr
      - Bool
      - 0
      - Remove all the docstring in the script
-   * - rft_builtin
+   * - enable_builtin
      - Bool
      - 0
      - Rename builtin names such as `print` etc.
-   * - rft_argument
+   * - enable_argument
      - Enum
      - 3
      - How to rename arguments in the function
@@ -132,13 +132,13 @@ Set option value. For example::
        - 1: only rename position-only arguments
        - 2: rename all the arguments except keyword-only arguments
        - 3: rename all the arguments
-   * - rft_auto_export
+   * - enable_auto_export
      - Bool
      - 0
      - Export all the names list in the module attribute `__all__`
 
        Exported names won't be renamed
-   * - rft_exclude_names
+   * - exclude_names
      - List
      -
      - List all exported function, class, attributes
@@ -150,43 +150,24 @@ Set option value. For example::
           "name"
           "cls.name"
 
-          "modname:name"
-          "modname:cls.name"
+          "modname::name"
+          "modname::cls.name"
 
-          "modname:*"
-          "^name"
+          "modname::*"
+          ":name"
 
        Note that arguments and local variables are always renamed
-   * - rft_exclude_args
+   * - exclude_funcs
      - List
      -
      - List all the functions which arguments can't be reformed
 
        The support formats::
 
           "func"
-          "modname:func"
-          "modname:cls.method"
+          "modname::func"
+          "modname::cls.method"
    * - extra_builtins
      - List
      -
      - Extra builtin name
-   * - var_type_table
-     - List
-     -
-     - Define type for variable
-
-       The support formats::
-
-          modname:func.var typename
-          modname:cls.method.var typename
-
-       If this variable is defined in For/With/Except/Comprehension, then use this format::
-
-          {modname:func.var} typename
-
-       The formats of typename:
-
-       - "cls":          The class name in same module
-       - "modname:cls":  The module name and class name
-       - "<any>":        Any builtin type

pyarmor/docs/en/user/man.rst

@@ -252,7 +252,7 @@ Refer to :doc:`configuration` for all available options
      $ pyarmor env -p info
 
      Sections:
-     rft_option
+     rft
 
      Options:
      src  scripts  modules  packages  excludes  recursive
@@ -263,13 +263,13 @@ Refer to :doc:`configuration` for all available options
 
      $ pyarmor env -p info excludes
 
-   Show all the options in section `rft_option`::
+   Show all the options in section `rft`::
 
-     $ pyarmor env -p info rft_option
+     $ pyarmor env -p info rft
 
-   Show the usage of option `rft_argument` in the section `rft_option`::
+   Show the usage of option `enable_argument` in the section `rft`::
 
-     $ pyarmor env -p info rft_option:rft_argument
+     $ pyarmor env -p info rft:enable_argument
 
 .. describe:: get
 
@@ -279,17 +279,17 @@ Refer to :doc:`configuration` for all available options
 
    OPTION may be format like `SECTION:OPTION`. For example::
 
-     $ pyarmor env -p get rft_option:rft_argument
+     $ pyarmor env -p get rft:enable_argument
 
 .. describe:: set, reset
 
    Change option value or restore default value. For example::
 
      $ pyarmor env -p set recursive 1
-     $ pyarmor env -p set rft_option:rft_argument 0
+     $ pyarmor env -p set rft:enable_argument 0
 
      $ pyarmor env -p reset recursive
-     $ pyarmor env -p reset rft_option:rft_argument
+     $ pyarmor env -p reset rft:enable_argument
 
 .. describe:: push, pop
 
@@ -349,16 +349,16 @@ Refer to :doc:`configuration` for all available options
 
             (project) ls
             Sections:
-            rft_option
+            rft
 
             Options:
             src  scripts  modules  packages  excludes  recursive
       * - cd
         - Switch section
-        - Enter section `rft_option`, then back to parent::
+        - Enter section `rft`, then back to parent::
 
-            (project) cd rft_option
-            (project)[rft_option] cd ..
+            (project) cd rft
+            (project)[rft] cd ..
             (project)
       * - get
         - Show option value
@@ -399,14 +399,14 @@ Refer to :doc:`configuration` for all available options
 
             (project) info
 
-          List all options in section `rft_option`::
+          List all options in section `rft`::
 
-            (project) info rft_option
+            (project) info rft
 
-          Show option `rft_argument` usage::
+          Show option `enable_argument` usage::
 
-            (project) cd rft_option
-            (project)[rft_option] info rft_argument
+            (project) cd rft
+            (project)[rft] info enable_argument
 
 pyarmor build
 =============
@@ -419,7 +419,7 @@ Generate obfuscated scripts for project
 
    [#]_ pyarmor build -h
 
-   [#]_ pyarmor build [--mini | --rft]
+   [#]_ pyarmor build [--mini | --rft | --mini-rft]
 
    [#]_ pyarmor build [--autofix {0,1}]
 
@@ -444,6 +444,12 @@ Generate obfuscated scripts for project
 
      $ pyarmor build --rft
 
+.. option:: --mini-rft
+
+   First refactor the scripts as :term:`RFT Script`, then generate :term:`Mini Script` for this project::
+
+     $ pyarmor build --mini-rft
+
 .. option:: --autofix {0,1}
 
    This option can simplifying the configuration for refactoring scripts.
@@ -454,7 +460,7 @@ Generate obfuscated scripts for project
 
    When auto-fix mode is enabled
 
-   - Always `rft_argument = 1`
+   - Always `enable_argument = 1`
    - Search all unknown attributes and add them to exclude table
 
    Then build the project::