Skip to content

Commit

Permalink
fixes of wrong escapes in asciidoc, \_, missing pass for __, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
virgo47 committed Oct 4, 2021
1 parent ab356f2 commit e0e6314
Show file tree
Hide file tree
Showing 31 changed files with 92 additions and 89 deletions.
4 changes: 3 additions & 1 deletion docs/cases/workflow-3/workflow-notifications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ The variable might be null if the object does not exist yet.

| (all)
| status
| SUCCESS = result is 'approved' (you can use also isApproved() method to determine this)FAILURE = result is 'rejected' (also isRejected() method)IN\_PROGRESS = result is not yet known (you can also use isResultKnown() to determine this)
| SUCCESS = result is 'approved' (you can use also isApproved() method to determine this) +
FAILURE = result is 'rejected' (also isRejected() method) +
IN_PROGRESS = result is not yet known (you can also use isResultKnown() to determine this)
|


Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/clustering-ha/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ However, when running in clustered mode, there is no default, and this property
| This is the port on which JMX agent will listen.
It *must be specified* for clustered mode, because JMX is used to query status of individual nodes and to manage them (start/stop scheduler, stop tasks on that node).
And, if you test a clustering/failover configuration (more midPoint nodes) on a single machine, be sure to set this parameter to *different* values for individual midPoint nodes.
Otherwise, you will get "link:http://java.net[java.net].BindException: Address already in use: JVM\_Bind" exception on tomcat startup.
Otherwise, you will get "link:http://java.net[java.net].BindException: Address already in use: JVM_Bind" exception on tomcat startup.


| com.sun.management.jmxremote.ssl
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/post-initial-import.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
:page-upkeep-status: orange

Post-initial import works in a similar manner to initial data import.
Post-initial import imports files and executes bulk action scrips from MP\_HOME/post-initial-objects directory.
Post-initial import imports files and executes bulk action scrips from MP_HOME/post-initial-objects directory.
If the directory does not exist after starting of Midpoint, it will be created.

The suffix`_._done` is appended to the name of each file after importing/executing.
Expand Down
2 changes: 1 addition & 1 deletion docs/diag/common-problems.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For example you are using value of some user attributes in the password.



* Security violation: org.identityconnectors.framework.common.exceptions.PermissionDeniedException(Error modifying LDAP entry ...) unwillingToPerform: 0000052D: SvcErr: DSID-031A12D2, problem 5003 (WILL\_NOT\_PERFORM), data 0?? (53)).
* Security violation: org.identityconnectors.framework.common.exceptions.PermissionDeniedException(Error modifying LDAP entry ...) unwillingToPerform: 0000052D: SvcErr: DSID-031A12D2, problem 5003 (WILL_NOT_PERFORM), data 0?? (53)).

** User is trying to use his/her name/surname/loginname as part of the password.
bug:MID-1657[]
24 changes: 12 additions & 12 deletions docs/legacy/demo/upgrade-howto.adoc

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/legacy/eclipse-plugin/certificate-problems/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Steps:
image::image2016-9-3-0-15-58.png[]


. Go to the directory of _<java home>/lib/security_ (c:\program files\java\jre1.8.0\_102\lib\security in this case) and enter the following command:
. Go to the directory of _<java home>/lib/security_ (c:\program files\java\jre1.8.0_102\lib\security in this case) and enter the following command:

[source]
----
Expand Down
8 changes: 4 additions & 4 deletions docs/legacy/repo-ninja.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ When extracting repo-ninja-3.1-SNAPSHOT-bin.zip file in `\*/midpoint-home/bin`,
[source,bat]
----
rem Change the following line!
set MIDPOINT\_HOME="c:\midpoint-home"
set MIDPOINT_HOME="c:\midpoint-home"
rem Sets the basedir to the directory where libraries are located
set BASEDIR=%~dp0..
java -classpath "%BASEDIR%\lib\\*" -Dmidpoint.home=%MIDPOINT\_HOME% com.evolveum.midpoint.tools.ninja.Main %\*
java -classpath "%BASEDIR%\lib\*" -Dmidpoint.home=%MIDPOINT_HOME% com.evolveum.midpoint.tools.ninja.Main %*
----

And also *check `repo-ninja` file* which content should be following:
Expand All @@ -39,10 +39,10 @@ And also *check `repo-ninja` file* which content should be following:
----
#!/bin/bash
MIDPOINT\_HOME=/var/opt/midpoint
MIDPOINT_HOME=/var/opt/midpoint
BASEDIR="`dirname \"$0\"`/.."
exec java -classpath "$BASEDIR/lib/\*" -Dmidpoint.home=$MIDPOINT\_HOME com.evolveum.midpoint.tools.ninja.Main $\*
exec java -classpath "$BASEDIR/lib/*" -Dmidpoint.home=$MIDPOINT_HOME com.evolveum.midpoint.tools.ninja.Main $*
----

Also *verify up to date repo-ninja driver version* in \*\midpoint-home\lib such as repo-ninja-3.1-SNAPSHOT.jar (*has to be only one version in lib file because of mismatch risk*).
Expand Down
2 changes: 1 addition & 1 deletion docs/legacy/soap-client/sample.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Just edit few source files:
| OIDs of roles used in the sample
| `12345678-d34d-b33f-f00d-987987987988`(Pirate), `12345678-d34d-b33f-f00d-987987cccccc`(Captain)
| `src/main/java/com/evolveum/midpoint/testing/model/client/sample/Main.java`
| constants ROLE\_PIRATE\_OID, ROLE\_CAPTAIN\_OID
| constants ROLE_PIRATE_OID, ROLE_CAPTAIN_OID


|===
Expand Down
8 changes: 4 additions & 4 deletions docs/legacy/sso/midpoint-and-sso-using-gluu-howto.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In this example we are using:

* Apache 2

* mod\_auth\_openidc 2.2.x
* mod_auth_openidc 2.2.x



Expand All @@ -39,11 +39,11 @@ First version of the Howto document contributed by Dario Tongue
Firstly please make sure that you have Apache Tomcat and midPoint installed and working properly. Also install Apache with rewrite, proxy and proxy_http modules and configure them to work with Apache Tomcat and midPoint. There steps can be found in this previous how to.

Next configure Apache with SSL.
And install the mod\_auth\_openidc module onto Apache and configure it properly so it will work with your OpenID Connect Provider.
And install the mod_auth_openidc module onto Apache and configure it properly so it will work with your OpenID Connect Provider.
For more details follow the link:https://gluu.org/docs/ce/latest/integration/openidc-rp/[following how to].

The claim user\_name of our OpenID Connect Provider (Gluu in our case) matches midPoint user "name".
This also means that one of the scopes of your client mod\_auth\_openidc defined on your OpenID Connect Provider contains the claim user\_name.
The claim user_name of our OpenID Connect Provider (Gluu in our case) matches midPoint user "name".
This also means that one of the scopes of your client mod_auth_openidc defined on your OpenID Connect Provider contains the claim user_name.


== Apache configuration
Expand Down
6 changes: 3 additions & 3 deletions docs/misc/notifications/configuration/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -485,11 +485,11 @@ This has a slightly different meaning depending on the event category:



(\*) The result is either SUCCESS, WARNING, or NOT\_APPLICABLE.
(*) The result is either SUCCESS, WARNING, or NOT_APPLICABLE.

(\**) The result is either FATAL\_ERROR, PARTIAL\_ERROR or NOT\_APPLICABLE.
(**) The result is either FATAL_ERROR, PARTIAL_ERROR or NOT_APPLICABLE.

(\***) The result is IN\_PROGRESS.
(\***) The result is IN_PROGRESS.

Please note that we take into account only user (i.e. focus) modifications, *not* modifications of user's accounts.

Expand Down
6 changes: 3 additions & 3 deletions docs/misc/notifications/task-notifications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -112,15 +112,15 @@ Each handler start/stop is sent as a standalone event.

| Run result status
| Result of the handler execution, driving what will be done with the task.
Can have values of PERMANENT\_ERROR, TEMPORARY\_ERROR, FINISHED, FINISHED\_HANDLER, INTERRUPTED, RESTART\_REQUESTED.
Can have values of PERMANENT_ERROR, TEMPORARY_ERROR, FINISHED, FINISHED_HANDLER, INTERRUPTED, RESTART_REQUESTED.
(TODO - more information)
| Can be tested with isPermanentError(), isTemporaryError(), isFinished(), isInterrupted(), isRestartRequested() event methods.
|

| Status
| Status as stored in the task's operation result.
Can have values of SUCCESS, HANDLED\_ERROR, WARNING, PARTIAL\_ERROR, FATAL\_ERROR, IN\_PROGRESS, NOT\_APPLICABLE.
| Can be tested with <status> filter, or with isSuccess() - corresponds to SUCESS, HANDLED\_ERROR, WARNING, isOnlyFailure() - corresponds to FATAL\_ERROR, isFailure() - corresponds to PARTIAL\_ERROR or FATAL\_ERROR.
Can have values of SUCCESS, HANDLED_ERROR, WARNING, PARTIAL_ERROR, FATAL_ERROR, IN_PROGRESS, NOT_APPLICABLE.
| Can be tested with <status> filter, or with isSuccess() - corresponds to SUCESS, HANDLED_ERROR, WARNING, isOnlyFailure() - corresponds to FATAL_ERROR, isFailure() - corresponds to PARTIAL_ERROR or FATAL_ERROR.
|

| Message
Expand Down
2 changes: 1 addition & 1 deletion docs/misc/reports/configuration/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ To remove names of fields on all report pages except the 1st page in CSV report

<columnHeader> +
<band height="24" splitType="Stretch"> +
<printWhenExpression><![CDATA[$V{PAGE\_NUMBER}==1]]></printWhenExpression> +
<printWhenExpression><![CDATA[$V{PAGE_NUMBER}==1]]></printWhenExpression> +
<frame> +
<reportElement style="Column header" mode="Transparent" x="0" y="1" width="1000" height="19" isRemoveLineWhenBlank="true" uuid="3e8fdd6d-a6ff-4407-9a1e-5d6b4706300a"/> +
<staticText> +
Expand Down
2 changes: 1 addition & 1 deletion docs/misc/reports/examples/users-without-account.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ We need only report configuration with condition.
----

Please replace_ '----OID_OF_YOUR_ROLE----'_ with oid of your role and '----OID\_OF\_YOUR\_RESOURCE----' with oid of your resource.
Please replace_ '----OID_OF_YOUR_ROLE----'_ with oid of your role and '----OID_OF_YOUR_RESOURCE----' with oid of your resource.
14 changes: 7 additions & 7 deletions docs/repository/db/mariadb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ link:https://mariadb.com/kb/en/mariadb-connector-j-155-release-notes/[Release no

Please check also \*/apache-tomcat/bin/catalina.bat to point to correct midpoint home location *(please set your own path):*

set JAVA\_OPTS=%JAVA\_OPTS% -Dmidpoint.home=c:/midpoint\_3\_Node2 -XX:MaxPermSize=1024m
set JAVA_OPTS=%JAVA_OPTS% -Dmidpoint.home=c:/midpoint_3_Node2 -XX:MaxPermSize=1024m


== Driver
Expand All @@ -64,14 +64,14 @@ Use proper sql script based on the distribution your are using either stable or
For stable release check: +
- the latest midpoint link:http://www.evolveum.com/downloads/midpoint/3.4/[http://www.evolveum.com/downloads/midpoint/3.4/] +
- and download midpoint-3.4-dist.zip +
- Execute MySQL database script located in: \*\midpoint-3.4-dist.zip\config\sql\\_all\mysql-3.4-all.sql +
- Execute MySQL database script located in: \*\midpoint-3.4-dist.zip\config\sql_all\mysql-3.4-all.sql +
For snapshot check: +
- the latest commit number on link:https://bamboo.evolveum.com/browse/MID-TRUNK/latestSuccessful[https://bamboo.evolveum.com/browse/MID-TRUNK/latestSuccessful] +
- and download it via link:http://athena.evolveum.com/builds/master/[http://athena.evolveum.com/builds/master/] where .zip file should be selected (midpoint-3.5-SNAPSHOT-dist.zip). +
- Execute MySQL database script located in: \*\midpoint-3.5-SNAPSHOT-dist.zip\config\sql\\_all\mysql-3.4-all.sql (or mysql-3.5-all, whatever will be present)
- Execute MySQL database script located in: \*\midpoint-3.5-SNAPSHOT-dist.zip\config\sql_all\mysql-3.4-all.sql (or mysql-3.5-all, whatever will be present)

After starting tomcat in Windows via apache-tomcat\bin\startup.bat or Linux via apache-tomcat\bin\startup.sh open midpoint in browser link:http://localhost:8080/midpoint/admin/[http://localhost:8080/midpoint/admin/] Login:administrator Pass:5ecr3t and create new user.
Check in MySQL table m\_user where new user should be created: select \* from m\_user.
Check in MySQL table m_user where new user should be created: `select * from m_user`


== Common issues
Expand All @@ -81,7 +81,7 @@ Check in MySQL table m\_user where new user should be created: select \* from m\

As we're using VARCHAR(255) for string columns there are situations when your object properties can exceed this limit.
For example shadow name exceeds 255 characters (it's possible for long DNs in LDAP or Active Directory).
If you try to save such object you'll get an error "Data truncation: Data too long for column 'name\_orig' at row 1" and object is not saved to database.
If you try to save such object you'll get an error "Data truncation: Data too long for column 'name_orig' at row 1" and object is not saved to database.

If you try just to alter column to bigger size, you'll end up with "`#1071 - Specified key was too long; max key length is 767 bytes`" error (if there is an index or unique constraint on that column).
Reason for that is that by default VARCHAR(255) is maximum size for an indexes (also unique constraints) using utf8 and InnoDB storage.
Expand Down Expand Up @@ -111,10 +111,10 @@ ADD INDEX `iShadowNameNorm` (`name_norm`(255) ASC);



. Updating only column definitions and turning on innodb\_large\_prefix feature (Not tested with MidPoint) +
. Updating only column definitions and turning on innodb_large_prefix feature (Not tested with MidPoint) +
link:https://mariadb.com/kb/en/mariadb/xtradbinnodb-server-system-variables/#innodb_large_prefix[https://mariadb.com/kb/en/mariadb/xtradbinnodb-server-system-variables/#innodb_large_prefix]

Note that innodb\_large\_prefix is "ON" by default since MariaDB 10.2.2 (and is deprecated as well), so this problem should not appear with the default settings of MariaDB 10.2.2 and later.
Note that innodb_large_prefix is "ON" by default since MariaDB 10.2.2 (and is deprecated as well), so this problem should not appear with the default settings of MariaDB 10.2.2 and later.


=== Packet for query is too large
Expand Down
12 changes: 6 additions & 6 deletions docs/repository/db/ms-sql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
====
Tested SQL Server Collations:
* SQL\_Latin1\_General\_CP1\_CS\_AS
* SQL_Latin1_General_CP1_CS_AS
* SQL\_Czech\_CP1250\_CS\_AS
* SQL_Czech_CP1250_CS_AS
*Be aware* that using *CS* (case-sensitive) collation causes *column names in queries to be case-sensitive too!*
====
Expand Down Expand Up @@ -76,18 +76,18 @@ Log snippet:
Database schema is not compatible with the executing code.

Current version cannot be determined.
The metadata table (m\_global\_metadata) is missing or inaccessible.
The metadata table (m_global_metadata) is missing or inaccessible.
This indicates the version is below 3.9. +
Required version is: 4.0

Reason:

Since version 3.9, midPoint checks for presence of table m\_global\_metadata and will not start if table is not found.
Since version 3.9, midPoint checks for presence of table m_global_metadata and will not start if table is not found.

Resolution:

However, If you have DB wrongly set - missing the ALLOW\_SNAPSHOT\_ISOLATION option, you will not get usual "SQLServerException: Snapshot isolation transaction failed" but rather confusing error that m\_global\_metadata table is missing.
So you just run "ALTER DATABASE "midpoint" SET ALLOW\_SNAPSHOT\_ISOLATION ON;" to fix it.
However, If you have DB wrongly set - missing the ALLOW_SNAPSHOT_ISOLATION option, you will not get usual "SQLServerException: Snapshot isolation transaction failed" but rather confusing error that m_global_metadata table is missing.
So you just run "ALTER DATABASE "midpoint" SET ALLOW_SNAPSHOT_ISOLATION ON;" to fix it.

Jira:

Expand Down
16 changes: 8 additions & 8 deletions docs/repository/db/mysql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ link:http://dev.mysql.com/doc/relnotes/connector-j/en/cj-news-5-1-23.html[Releas
.Character sets and collation
====
MySQL 5.6 until version 8 has quite messy utf8 charset support.
For MySQL 5.6 we can use utf8 charset (alias pointing to utf8mb3 - not full utf8) with collations like utf8\_general\_ci (case insensitive) or utf8\_bin (case sensitive), but these collations will break order by - they compare only character code points, so upper case characters will be before lower case characters.
For MySQL 5.6 we can use utf8 charset (alias pointing to utf8mb3 - not full utf8) with collations like utf8_general_ci (case insensitive) or utf8_bin (case sensitive), but these collations will break order by - they compare only character code points, so upper case characters will be before lower case characters.
From Mysql 8, mysql team recomends charset `utf8mb4`. Collation for correct searches would be `utf8mb4_0900_as_cs`. `utf8mb4` is mainly necessary for deployments with extensive use of accented characters.
====
Expand Down Expand Up @@ -84,14 +84,14 @@ Use proper sql script based on the distribution your are using either stable or
For stable release check: +
- the latest midpoint link:http://www.evolveum.com/downloads/midpoint/3.4/[http://www.evolveum.com/downloads/midpoint/3.4/] +
- and download midpoint-3.4-dist.zip +
- Execute MySQL database script located in: \*\midpoint-3.4-dist.zip\config\sql\\_all\mysql-3.4-all.sql +
- Execute MySQL database script located in: \*\midpoint-3.4-dist.zip\config\sql_all\mysql-3.4-all.sql +
For snapshot check: +
- the latest commit number on link:https://bamboo.evolveum.com/browse/MID-TRUNK/latestSuccessful[https://bamboo.evolveum.com/browse/MID-TRUNK/latestSuccessful] +
- and download it via link:http://athena.evolveum.com/builds/master/[http://athena.evolveum.com/builds/master/] where .zip file should be selected (midpoint-3.5-SNAPSHOT-dist.zip). +
- Execute MySQL database script located in: \*\midpoint-3.5-SNAPSHOT-dist.zip\config\sql\\_all\mysql-3.4-all.sql (or mysql-3.5-all, whatever will be present)
- Execute MySQL database script located in: \*\midpoint-3.5-SNAPSHOT-dist.zip\config\sql_all\mysql-3.4-all.sql (or mysql-3.5-all, whatever will be present)

After starting tomcat in Windows via apache-tomcat\bin\startup.bat or Linux via apache-tomcat\bin\startup.sh open midpoint in browser link:http://localhost:8080/midpoint/admin/[http://localhost:8080/midpoint/admin/] Login:administrator Pass:5ecr3t and create new user.
Check in MySQL table m\_user where new user should be created: select \* from m\_user.
Check in MySQL table m_user where new user should be created: `select * from m_user`


=== Errata
Expand All @@ -116,7 +116,7 @@ We're using it only during development in automatic build system, so we don't ne

As we're using VARCHAR(255) for string columns there are situations when your object properties can exceed this limit.
For example shadow name exceeds 255 characters (it's possible for long DNs in LDAP or Active Directory).
If you try to save such object you'll get an error "Data truncation: Data too long for column 'name\_orig' at row 1" and object is not saved to database.
If you try to save such object you'll get an error "Data truncation: Data too long for column 'name_orig' at row 1" and object is not saved to database.

If you try just to alter column to bigger size, you'll end up with "`#1071 - Specified key was too long; max key length is 767 bytes`" error (if there is an index or unique constraint on that column).
Reason for that is that by default VARCHAR(255) is maximum size for an indexes (also unique constraints) using utf8 and InnoDB storage (see link:http://dev.mysql.com/doc/refman/5.5/en/innodb-restrictions.html[http://dev.mysql.com/doc/refman/5.5/en/innodb-restrictions.html]).
Expand Down Expand Up @@ -148,11 +148,11 @@ ADD INDEX `iShadowNameNorm` (`name_norm`(255) ASC);
+


. Updating only column definitions and turning on innodb\_large\_prefix feature (Not tested with MidPoint) +
. Updating only column definitions and turning on innodb_large_prefix feature (Not tested with MidPoint) +
link:http://dev.mysql.com/doc/refman/5.5/en/innodb-parameters.html#sysvar_innodb_large_prefix[http://dev.mysql.com/doc/refman/5.5/en/innodb-parameters.html#sysvar_innodb_large_prefix]

Note that innodb\_large\_prefix is "ON" by default since MySQL 5.7.7 (and is deprecated as well), so this problem should not appear with the default settings of MySQL 5.7.7 and later.
But make sure you have also set the correct innodb\_file\_format as well (please see link:https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_large_prefix[here]).
Note that innodb_large_prefix is "ON" by default since MySQL 5.7.7 (and is deprecated as well), so this problem should not appear with the default settings of MySQL 5.7.7 and later.
But make sure you have also set the correct innodb_file_format as well (please see link:https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_large_prefix[here]).


=== Packet for query is too large
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/attribute-caching.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ It specifies maximum age of the value in millisecods.
The default value is zero, which means that a fresh value must always be returned.
This means that caches that do not guarantee fresh value cannot be used.
If non-zero value is specified then such caches may be used.
In case that Long.MAX\_VALUE is specified then the caches are always used and fresh value is never retrieved.
In case that Long.MAX_VALUE is specified then the caches are always used and fresh value is never retrieved.
This option was added in midPoint 3.5.

Both options can be used to get cached data.
Expand Down

0 comments on commit e0e6314

Please sign in to comment.