[SYCLomatic][DOC][NFC] Update user-defined rule doc for rule template…

…s/examples (#1987) Signed-off-by: Huang, Andy <[email protected]> Co-authored-by: Jiang, Zhiwei <[email protected]>
oneapi-src · Nov 8, 2024 · 94743d2 · 94743d2
1 parent 486da12
commit 94743d2
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/dev_guide/migration/migration-rules.rst b/docs/dev_guide/migration/migration-rules.rst
@@ -259,3 +259,25 @@ output source code:
 
    int *ptr, *ptr2;
    int * new_ptr = bar(*ptr, 30);
+
+
+More Examples and Rule Templates
+--------------------------------------------------------
+
+A set of rule examples that can be used as templates to implement new rules are 
+available in the *extensions/rule_templates* folder on the installation path of
+the tool.
+
+.. code-block:: bash
+
+   extensions
+   ├── rule_templates
+       ├── api_rule.yaml
+       ├── class_rule.yaml
+       ├── disable_rule.yaml
+       ├── enum_rule.yaml
+       ├── header_rule.yaml
+       ├── helper_function_rule.yaml
+       ├── macro_rule.yaml
+       ├── pattern_rewrite_rule.yaml
+       └── type_rule.yaml