Move attribute explanations to the top of the file

doctrine · Feb 5, 2019 · f7f30d8 · f7f30d8
1 parent dc930bc
commit f7f30d8
Showing 1 changed file with 31 additions and 16 deletions.
diff --git a/Resources/doc/configuration.rst b/Resources/doc/configuration.rst
@@ -1003,33 +1003,48 @@ can configure. The following block shows all possible configuration keys:
                 http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
 
             <doctrine:config>
+                <!-- path: SQLite specific -->
+                <!-- memory: SQLite specific -->
+                <!-- multiple-active-result-sets: driver specific -->
+                <!-- pooled: Oracle specific (SERVER=POOLED) -->
+                <!-- protocol: IBM DB2 specific (PROTOCOL) -->
+                <!-- server: SQL Anywhere specific (ServerName) -->
+                <!-- service: Oracle specific (SERVICE_NAME instead of SID) -->
+                <!-- servicename: Oracle specific (SERVICE_NAME) -->
+                <!-- sessionMode: oci8 driver specific (session_mode) -->
+                <!-- default_dbname: PostgreSQL specific (default_dbname) -->
+                <!-- sslmode: PostgreSQL specific (LIBPQ-CONNECT-SSLMODE) -->
+                <!-- sslrootcert: PostgreSQL specific (LIBPQ-CONNECT-SSLROOTCERT) -->
+                <!-- sslcert: PostgreSQL specific (LIBPQ-CONNECT-SSLCERT) -->
+                <!-- sslkey: PostgreSQL specific (LIBPQ-CONNECT-SSLKEY) -->
+                <!-- sslcrl: PostgreSQL specific (LIBPQ-CONNECT-SSLCRL) -->
                 <doctrine:dbal
                     name="default"
-                    url="mysql://user:secret@localhost:1234/otherdatabase" <!-- this would override the values below -->
+                    url="mysql://user:secret@localhost:1234/otherdatabase"
                     dbname="database"
                     host="localhost"
                     port="1234"
                     user="user"
                     password="secret"
                     driver="pdo_mysql"
                     driver-class="MyNamespace\MyDriverImpl"
-                    path="%kernel.project_dir%/var/data.db" <!-- SQLite specific -->
-                    memory="true"                           <!-- SQLite specific -->
+                    path="%kernel.project_dir%/var/data.db"
+                    memory="true"
                     unix-socket="/tmp/mysql.sock"
                     persistent="true"
-                    multiple-active-result-sets="true" <!-- pdo_sqlsrv driver specific -->
-                    pooled="true"                      <!-- Oracle specific (SERVER=POOLED) -->
-                    protocol="TCPIP"                   <!-- IBM DB2 specific (PROTOCOL) -->
-                    server="my_database_server"        <!-- SQL Anywhere specific (ServerName) -->
-                    service="true"                     <!-- Oracle specific (SERVICE_NAME instead of SID) -->
-                    servicename="MyOracleServiceName"  <!-- Oracle specific (SERVICE_NAME) -->
-                    sessionMode"2"                     <!-- oci8 driver specific (session_mode) -->
-                    default_dbname="database"          <!-- PostgreSQL specific (default_dbname) -->
-                    sslmode="require"                  <!-- PostgreSQL specific (LIBPQ-CONNECT-SSLMODE) -->
-                    sslrootcert="postgresql-ca.pem"    <!-- PostgreSQL specific (LIBPQ-CONNECT-SSLROOTCERT) -->
-                    sslcert="postgresql-cert.pem"      <!-- PostgreSQL specific (LIBPQ-CONNECT-SSLCERT) -->
-                    sslkey="postgresql-key.pem"        <!-- PostgreSQL specific (LIBPQ-CONNECT-SSLKEY) -->
-                    sslcrl="postgresql.crl"            <!-- PostgreSQL specific (LIBPQ-CONNECT-SSLCRL) -->
+                    multiple-active-result-sets="true"
+                    pooled="true"
+                    protocol="TCPIP"
+                    server="my_database_server"
+                    service="true"
+                    servicename="MyOracleServiceName"
+                    sessionMode="2"
+                    default_dbname="database"
+                    sslmode="require"
+                    sslrootcert="postgresql-ca.pem"
+                    sslcert="postgresql-cert.pem"
+                    sslkey="postgresql-key.pem"
+                    sslcrl="postgresql.crl"
                     wrapper-class="MyDoctrineDbalConnectionWrapper"
                     charset="UTF8"
                     logging="%kernel.debug%"