From 63f46981fcd6974fbaed6335205d22f5135b4e9e Mon Sep 17 00:00:00 2001
From: Maxim Thomas <maxim.thomas@gmail.com>
Date: Mon, 14 Oct 2024 17:24:54 +0000
Subject: [PATCH] [#423] Eliminate asciidoctor warning messages when generating documentation (#429)
---
opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-ldap-operations.adoc | 2 +-
opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-dsjavaproperties.adoc | 2 +-
opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-windows-service.adoc | 2 +-
opendj-doc-generated-ref/pom.xml | 3 +++
opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-makeldif-template.adoc | 4 ++--
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-admin-tools.adoc | 2 +-
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-import-export.adoc | 2 +-
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-tuning.adoc | 2 +-
opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-rest2ldap.adoc | 16 ++++++++--------
9 files changed, 19 insertions(+), 16 deletions(-)
diff --git a/opendj-doc-generated-ref/pom.xml b/opendj-doc-generated-ref/pom.xml
index 0ca7b9b..45aac84 100644
--- a/opendj-doc-generated-ref/pom.xml
+++ b/opendj-doc-generated-ref/pom.xml
@@ -565,6 +565,9 @@
<fileset dir="${basedir}/src/main/asciidoc/man-pages" includes="**/*" />
<fileset dir="${project.build.directory}/asciidoc/source/man-pages" includes="**/*" />
</copy>
+ <delete>
+ <fileset dir="${project.build.directory}/asciidoc/source/man-pages" includes="man-*-subcommands-ref*" />
+ </delete>
</tasks>
</configuration>
</execution>
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-admin-tools.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-admin-tools.adoc
index 82d5895..caa1943 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-admin-tools.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-admin-tools.adoc
@@ -320,7 +320,7 @@
The `make-ldif` command is designed to help generate test data that mimics data expected in production, but without compromising real, potentially private information.
+
-For details see xref:../reference/admin-tools-ref.adoc#make-ldif-1[make-ldif(1)] in the __Reference__.
+For details see xref:../reference/admin-tools-ref.adoc#makeldif-1[makeldif(1)] in the __Reference__.
`manage-account`::
Lock and unlock user accounts, and view and manipulate password policy state information.
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-import-export.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-import-export.adoc
index f5f8d76..6233cb5 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-import-export.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-import-export.adoc
@@ -40,7 +40,7 @@
[#generating-ldif]
=== Generating Test Data
-When you install OpenDJ, you have the option of importing sample data that is generated during the installation. This procedure demonstrates how to generate LDIF by using the `make-ldif` command, described in xref:../reference/admin-tools-ref.adoc#make-ldif-1[make-ldif(1)] in the __Reference__.
+When you install OpenDJ, you have the option of importing sample data that is generated during the installation. This procedure demonstrates how to generate LDIF by using the `make-ldif` command, described in xref:../reference/admin-tools-ref.adoc#makeldif-1[makeldif(1)] in the __Reference__.
[#generate-ldif]
.To Generate Test LDIF Data
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-tuning.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-tuning.adoc
index ec56675..3e58b54 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-tuning.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-tuning.adoc
@@ -112,7 +112,7 @@
In your test environment, you set up OpenDJ as you will later in production, and then conduct experiments to determine how best to meet the requirements defined in the SLA.
-Use the `make-ldif` command, described in xref:../reference/admin-tools-ref.adoc#make-ldif-1[make-ldif(1)] in the __Reference__, to generate sample data that match what you expect to find in production.
+Use the `make-ldif` command, described in xref:../reference/admin-tools-ref.adoc#makeldif-1[makeldif(1)] in the __Reference__, to generate sample data that match what you expect to find in production.
The OpenDJ LDAP Toolkit provides command-line tools to help with basic performance testing:
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-dsjavaproperties.adoc b/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-dsjavaproperties.adoc
index 9dfbf43..f4f3217 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-dsjavaproperties.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-dsjavaproperties.adoc
@@ -25,7 +25,7 @@
:mansource: OpenDJ
== Name
-dsjavaproperties — apply OpenDJ Java home and JVM settings
+dsjavaproperties - apply OpenDJ Java home and JVM settings
== Synopsis
`dsjavaproperties`
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-makeldif-template.adoc b/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-makeldif-template.adoc
index f1f1829..e1d0ca9 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-makeldif-template.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-makeldif-template.adoc
@@ -23,7 +23,7 @@
:mansource: OpenDJ
== Name
-makeldif-template — template file for the make-ldif command
+makeldif-template - template file for the make-ldif command
== Synopsis
@@ -267,4 +267,4 @@
== See Also
-xref:#make-ldif-1[make-ldif(1)], the OpenDJ directory server template file `/path/to/opendj/config/MakeLDIF/example.template`
\ No newline at end of file
+xref:#makeldif-1[makeldif(1)], the OpenDJ directory server template file `/path/to/opendj/config/MakeLDIF/example.template`
\ No newline at end of file
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-windows-service.adoc b/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-windows-service.adoc
index a5d9ee2..2a74099 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-windows-service.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/man-pages/man-windows-service.adoc
@@ -25,7 +25,7 @@
:mansource: OpenDJ
== Name
-windows-service — register OpenDJ as a Windows Service
+windows-service - register OpenDJ as a Windows Service
== Synopsis
`windows-service` {options}
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-rest2ldap.adoc b/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-rest2ldap.adoc
index 0dc2d0a..2649d83 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-rest2ldap.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-rest2ldap.adoc
@@ -820,16 +820,16 @@
a|`resourceTypeProperty` (string, required for inheritance)
a|Name of the resource type property that specifies the type of this resource.
- REST to LDAP uses this to determine the resource subtype when creating a resource.
+REST to LDAP uses this to determine the resource subtype when creating a resource.
- This points the mapper to the type of the resource. The specified property must be of type `resourceType`.
+This points the mapper to the type of the resource. The specified property must be of type `resourceType`.
a|`properties` (map, optional)
a|Map of property names to property definitions.
- Unlike LDAP entries, JSON resources are not necessarily flat. You can define nested properties of type `object` that have their own properties.
+Unlike LDAP entries, JSON resources are not necessarily flat. You can define nested properties of type `object` that have their own properties.
- For details on properties configuration, see xref:#rest-resource-type-properties-map["Properties of Resource Type Properties Objects"].
+For details on properties configuration, see xref:#rest-resource-type-properties-map["Properties of Resource Type Properties Objects"].
a|`subResources` (map, optional)
a|Map of subresource names to subresource definitions.
@@ -855,12 +855,12 @@
a|`isAbstract` (boolean, optional)
a|Whether this is an abstract resource type used only for inheritance.
- Default: `false`
+Default: `false`
a|`superType` (string, optional)
a|Name of the resource type that this resource type extends. Resource types that extend another type inherit properties of the extended type, and inherit subresource definitions.
- Default: none. This resource type does not extend another type.
+Default: none. This resource type does not extend another type.
a|`objectClasses` (array, optional)
a|Names of the LDAP object classes that this type corresponds to. When an object of this type is created, these object class names are added to the list of object classes on the LDAP entry. The LDAP object classes are not shown in the JSON resource.
@@ -870,7 +870,7 @@
a|`supportedActions` (array, optional)
a|Names of the common REST actions that this resource type supports. The names must match actions allowed on the resource in the underlying implementation.
- Default: none.
+Default: none.
a|`includeAllUserAttributesByDefault` (boolean, optional)
a|Whether to include all LDAP user attributes as properties of the JSON resource. If `true`, the property names in the JSON resource match the attribute names in the LDAP entries.
@@ -965,7 +965,7 @@
a|`defaultJsonValue`
a|Sets the JSON value if no corresponding LDAP attribute is present.
- No default is set if this is omitted.
+No default is set if this is omitted.
a|`isBinary`
a|Whether the underlying LDAP attribute holds a binary value, such as a JPEG photo or a digital certificate.
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-ldap-operations.adoc b/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-ldap-operations.adoc
index 22c0edc..effc7ce 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-ldap-operations.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/server-dev-guide/chap-ldap-operations.adoc
@@ -260,7 +260,7 @@
The `make-ldif` command is designed to help generate test data that mimics data expected in production, but without compromising real, potentially private information.
+
-For details see xref:../reference/admin-tools-ref.adoc#make-ldif-1[make-ldif(1)] in the __Reference__.
+For details see xref:../reference/admin-tools-ref.adoc#makeldif-1[makeldif(1)] in the __Reference__.
`manage-account`::
Lock and unlock user accounts, and view and manipulate password policy state information.
--
Gitblit v1.10.0