From 510d41ff7d12c8a8ba230d3b3f732b19a20f15e3 Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周六, 31 10月 2020 10:28:34 +0800
Subject: [PATCH] doc & miscellaneous changes
---
doc/api/extend.rst | 34 +++++++++++++++++++++++++++-------
1 files changed, 27 insertions(+), 7 deletions(-)
diff --git a/doc/api/extend.rst b/doc/api/extend.rst
index 8deda9a..2521a92 100644
--- a/doc/api/extend.rst
+++ b/doc/api/extend.rst
@@ -1,20 +1,40 @@
#######################################
-Customizations
+Extension points
#######################################
The version 2.0 of the library comes with clear API extension and customization points.
-Custom hardware signature generator
+Tweak hardware signature generator
***************************************
-You've found the provided hardware signatures don't behave well for your customers (we can test on a limited set of
-hardware we've receiving reports of usage on environments we never imagined before).
-You can either change the way the default strategy behaves (choose for instance cpu type over disk label as default) or
-invent your own identification method.
+If the provided hardware signatures don't behave well for your customers, or you want to change the default
+way the library generates the pc identifier you can have a look at the following section.
+
+First of all be sure to read about the standard behavior of :c:func:`identify_pc` here:
.. toctree::
hardware_identifiers
+
+
+Change the hardware identification strategy
+============================================
+
+Included with the library there are three hardware identification strategies: `IP_ADDRESS`, `STRATEGY_ETHERNET` (mac address) and
+`STRATEGY_ETHERNET` (partition serial number). If you want to change the preferred one:
+
+ - locate the file `licensecc_properties.h`` (usually in ``projects/<$project_name>/include/licensecc/<$project_name>``
+ - you can change the order of the strategies in the following code block (the strategies will be tried in sequence until the first one succeeds):
+
+.. code-block:: c
+
+#define LCC_BARE_TO_METAL_STRATEGIES { STRATEGY_ETHERNET, STRATEGY_ETHERNET, STRATEGY_NONE }
+#define LCC_VM_STRATEGIES { STRATEGY_ETHERNET, STRATEGY_NONE }
+#define LCC_LXC_STRATEGIES { STRATEGY_ETHERNET, STRATEGY_NONE }
+#define LCC_DOCKER_STRATEGIES { STRATEGY_NONE }
+#define LCC_CLOUD_STRATEGIES { STRATEGY_NONE }
+
+
Custom license locator
***************************************
@@ -23,4 +43,4 @@
.. TODO::
- this section need to be completed
\ No newline at end of file
+ this section need to be completed
--
Gitblit v1.9.1