Fix formatting as required by markdownfmt

mysql/README.md

@@ -1,78 +1,103 @@
-# Supported tags and respective `Dockerfile` links
+Supported tags and respective `Dockerfile` links
+================================================
 
--	[`5.5.42`, `5.5` (*5.5/Dockerfile*)](https://github.com/docker-library/mysql/blob/8ed790ab199eeef0f36ef0547ae28e5654cbef0d/5.5/Dockerfile)
--	[`5.6.23`, `5.6`, `5`, `latest` (*5.6/Dockerfile*)](https://github.com/docker-library/mysql/blob/8ed790ab199eeef0f36ef0547ae28e5654cbef0d/5.6/Dockerfile)
--	[`5.7.6-m16`, `5.7.6`, `5.7` (*5.7/Dockerfile*)](https://github.com/docker-library/mysql/blob/e0d58135e8c54a918037cfe9ea3077a3a088e0de/5.7/Dockerfile)
+-	[`5.5.42`, `5.5` (*5.5/Dockerfile*\)](https://github.com/docker-library/mysql/blob/8ed790ab199eeef0f36ef0547ae28e5654cbef0d/5.5/Dockerfile)
+-	[`5.6.23`, `5.6`, `5`, `latest` (*5.6/Dockerfile*\)](https://github.com/docker-library/mysql/blob/8ed790ab199eeef0f36ef0547ae28e5654cbef0d/5.6/Dockerfile)
+-	[`5.7.6-m16`, `5.7.6`, `5.7` (*5.7/Dockerfile*\)](https://github.com/docker-library/mysql/blob/e0d58135e8c54a918037cfe9ea3077a3a088e0de/5.7/Dockerfile)
 
-For more information about this image and its history, please see the [relevant manifest file (`library/mysql`)](https://github.com/docker-library/official-images/blob/master/library/mysql) in the [`docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images).
+For more information about this image and its history, please see the [relevant manifest file (`library/mysql`\)](https://github.com/docker-library/official-images/blob/master/library/mysql) in the [`docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images).
 
 ![logo](https://raw.githubusercontent.com/docker-library/docs/master/mysql/logo.png)
 
-# What is MySQL?
+What is MySQL?
+==============
 
 MySQL is the world's most popular open source database. With its proven performance, reliability and ease-of-use, MySQL has become the leading database choice for web-based applications, covering the entire range from personal projects and websites, via e-commerce and information services, all the way to high profile web properties including Facebook, Twitter, YouTube, Yahoo! and many more.
 
 For more information and related downloads for MySQL Server and other MySQL products, please visit [www.mysql.com](http://www.mysql.com).
 
-# How to use this image
+How to use this image
+=====================
 
-## Start a `mysql` server instance
+Start a `mysql` server instance
+-------------------------------
 
 Starting a MySQL instance is simple:
 
-	docker run --name some-mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag
+```
+docker run --name some-mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag
+```
 
 ... where `some-mysql` is the name you want to assign to your container, `my-secret-pw` is the password to be set for the MySQL root user and `tag` is the tag specifying the MySQL version you want. See the list above for relevant tags.
 
-## Connect to MySQL from an application in another Docker container
+Connect to MySQL from an application in another Docker container
+----------------------------------------------------------------
 
 This image exposes the standard MySQL port (3306), so container linking makes the MySQL instance available to other application containers. Start your application container like this in order to link it to the MySQL container:
 
-	docker run --name some-app --link some-mysql:mysql -d app-that-uses-mysql
+```
+docker run --name some-app --link some-mysql:mysql -d app-that-uses-mysql
+```
 
-## Connect to MySQL from the MySQL command line client
+Connect to MySQL from the MySQL command line client
+---------------------------------------------------
 
 The following command starts another MySQL container instance and runs the `mysql` command line client against your original MySQL container, allowing you to execute SQL statements against your database instance:
 
-	docker run -it --link some-mysql:mysql --rm mysql sh -c 'exec mysql -h"$MYSQL_PORT_3306_TCP_ADDR" -P"$MYSQL_PORT_3306_TCP_PORT" -uroot -p"$MYSQL_ENV_MYSQL_ROOT_PASSWORD"'
-	
+```
+docker run -it --link some-mysql:mysql --rm mysql sh -c 'exec mysql -h"$MYSQL_PORT_3306_TCP_ADDR" -P"$MYSQL_PORT_3306_TCP_PORT" -uroot -p"$MYSQL_ENV_MYSQL_ROOT_PASSWORD"'
+```
+
 ... where `some-mysql` is the name of your original MySQL Server container.
 
 More information about the MySQL command line client can be found in the [MySQL documentation](http://dev.mysql.com/doc/en/mysql.html)
 
-## Container shell access and viewing MySQL logs
+Container shell access and viewing MySQL logs
+---------------------------------------------
 
 The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `mysql` container:
 
-	docker exec -it some-mysql bash
+```
+docker exec -it some-mysql bash
+```
 
 The MySQL Server log is available through Docker's container log:
 
-	docker logs some-mysql
+```
+docker logs some-mysql
+```
 
-## Using a custom MySQL configuration file
+Using a custom MySQL configuration file
+---------------------------------------
 
 The MySQL startup configuration is specified in the file `/etc/mysql/my.cnf`. If you want to customize this configuration for your own purposes, you can create your alternative configuration file in a directory on the host machine and then mount this file in the appropriate location inside the `mysql` container, effectively replacing the standard configuration file.
 
 If you want to base your changes on the standard configuration file, start your `%%REPO` container in the standard way described above, then do:
 
-	docker exec -it some-mysql cat /etc/mysql/my.cnf > /my/custom/config-file
+```
+docker exec -it some-mysql cat /etc/mysql/my.cnf > /my/custom/config-file
+```
 
 ... where `/my/custom/config-file` is the path and name of the new configuration file. Then start a new `mysql` container like this:
 
-	docker run --name new-conf-mysql -v /my/custom/config-file:/etc/mysql/my.cnf -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag
+```
+docker run --name new-conf-mysql -v /my/custom/config-file:/etc/mysql/my.cnf -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag
+```
 
 This will start a new container `new-conf-mysql` where the MySQL instance uses the startup options specified in `/my/custom/config-file`.
 
 Note that users on host systems with SELinux enabled may see issues with this. The current workaround is to assign the relevant SELinux policy type to your new config file so that the container will be allowed to mount it:
 
-	chcon -Rt svirt_sandbox_file_t /my/custom/config-file
+```
+chcon -Rt svirt_sandbox_file_t /my/custom/config-file
+```
 
-## Environment Variables
+Environment Variables
+---------------------
 
 When you start the `mysql` image, you can adjust the configuration of the MySQL instance by passing one or more environment variables on the `docker run` command line. Do note that none of the variables below will have any effect if you start the container with a data directory that already contains a database: any pre-existing database will always be left untouched on container startup.
 
-## `MYSQL_ROOT_PASSWORD`
+### `MYSQL_ROOT_PASSWORD`
 
 This variable is mandatory and specifies the password that will be set for the MySQL `root` superuser account. In the above example, it was set to `my-secret-pw`.
 
@@ -90,9 +115,11 @@ Do note that there is no need to use this mechanism to create the root superuser
 
 This is an optional variable. Set to `yes` to allow the container to be started with a blank password for the root user. *NOTE*: Setting this variable to `yes` is not recommended unless you really know what you are doing, since this will leave your MySQL instance completely unprotected, allowing anyone to gain complete superuser access.
 
-# Caveats
+Caveats
+=======
 
-## Where to Store Data
+Where to Store Data
+-------------------
 
 Important note: There are several ways to store data used by applications that run in Docker containers. We encourage users of the `mysql` images to familiarize themselves with the options available, including:
 
@@ -102,39 +129,49 @@ Important note: There are several ways to store data used by applications that r
 The Docker documentation is a good starting point for understanding the different storage options and variations, and there are multiple blogs and forum postings that discuss and give advice in this area. We will simply show the basic procedure here for the latter option above:
 
 1.	Create a data directory on a suitable volume on your host system, e.g. `/my/own/datadir`.
-2.  Start your `mysql` container like this:
+2.	Start your `mysql` container like this:
 
-		docker run --name some-mysql -v /my/own/datadir:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag
+	```
+	docker run --name some-mysql -v /my/own/datadir:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql:tag
+	```
 
 The `-v /my/own/datadir:/var/lib/mysql` part of the command mounts the `/my/own/datadir` directory from the underlying host system as `/var/lib/mysql` inside the container, where MySQL by default will write its data files.
 
 Note that users on host systems with SELinux enabled may see issues with this. The current workaround is to assign the relevant SELinux policy type to the new data directory so that the container will be allowed to access it:
 
-	chcon -Rt svirt_sandbox_file_t /my/own/datadir
+```
+chcon -Rt svirt_sandbox_file_t /my/own/datadir
+```
 
-## No connections until MySQL init completes
+No connections until MySQL init completes
+-----------------------------------------
 
 If there is no database initialized when the container starts, then a default database will be created. While this is the expected behavior, this means that it will not accept incoming connections until such initialization completes. This may cause issues when using automation tools, such as `docker-compose`, which start several containers simultaneously.
 
-## Usage against an existing database
+Usage against an existing database
+----------------------------------
 
 If you start your `mysql` container instance with a data directory that already contains a database (specifically, a `mysql` subdirectory), the `$MYSQL_ROOT_PASSWORD` variable should be omitted from the run command line; it will in any case be ignored, and the pre-existing database will not be changed in any way.
 
-# Supported Docker versions
+Supported Docker versions
+=========================
 
 This image is officially supported on Docker version 1.5.0.
 
 Support for older versions (down to 1.0) is provided on a best-effort basis.
 
-# User Feedback
+User Feedback
+=============
 
-## Issues
+Issues
+------
 
 If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/docker-library/mysql/issues).
 
 You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
 
-## Contributing
+Contributing
+------------
 
 You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
 

mysql/content.md

@@ -1,70 +1,94 @@
 %%LOGO%%
 
-# What is MySQL?
+What is MySQL?
+==============
 
 MySQL is the world's most popular open source database. With its proven performance, reliability and ease-of-use, MySQL has become the leading database choice for web-based applications, covering the entire range from personal projects and websites, via e-commerce and information services, all the way to high profile web properties including Facebook, Twitter, YouTube, Yahoo! and many more.
 
 For more information and related downloads for MySQL Server and other MySQL products, please visit [www.mysql.com](http://www.mysql.com).
 
-# How to use this image
+How to use this image
+=====================
 
-## Start a `%%REPO%%` server instance
+Start a `%%REPO%%` server instance
+----------------------------------
 
 Starting a MySQL instance is simple:
 
-	docker run --name some-%%REPO%% -e MYSQL_ROOT_PASSWORD=my-secret-pw -d %%REPO%%:tag
+```
+docker run --name some-%%REPO%% -e MYSQL_ROOT_PASSWORD=my-secret-pw -d %%REPO%%:tag
+```
 
 ... where `some-%%REPO%%` is the name you want to assign to your container, `my-secret-pw` is the password to be set for the MySQL root user and `tag` is the tag specifying the MySQL version you want. See the list above for relevant tags.
 
-## Connect to MySQL from an application in another Docker container
+Connect to MySQL from an application in another Docker container
+----------------------------------------------------------------
 
 This image exposes the standard MySQL port (3306), so container linking makes the MySQL instance available to other application containers. Start your application container like this in order to link it to the MySQL container:
 
-	docker run --name some-app --link some-%%REPO%%:mysql -d app-that-uses-mysql
+```
+docker run --name some-app --link some-%%REPO%%:mysql -d app-that-uses-mysql
+```
 
-## Connect to MySQL from the MySQL command line client
+Connect to MySQL from the MySQL command line client
+---------------------------------------------------
 
 The following command starts another MySQL container instance and runs the `mysql` command line client against your original MySQL container, allowing you to execute SQL statements against your database instance:
 
-	docker run -it --link some-%%REPO%%:mysql --rm %%REPO%% sh -c 'exec mysql -h"$MYSQL_PORT_3306_TCP_ADDR" -P"$MYSQL_PORT_3306_TCP_PORT" -uroot -p"$MYSQL_ENV_MYSQL_ROOT_PASSWORD"'
-	
+```
+docker run -it --link some-%%REPO%%:mysql --rm %%REPO%% sh -c 'exec mysql -h"$MYSQL_PORT_3306_TCP_ADDR" -P"$MYSQL_PORT_3306_TCP_PORT" -uroot -p"$MYSQL_ENV_MYSQL_ROOT_PASSWORD"'
+```
+
 ... where `some-%%REPO%%` is the name of your original MySQL Server container.
 
 More information about the MySQL command line client can be found in the [MySQL documentation](http://dev.mysql.com/doc/en/mysql.html)
 
-## Container shell access and viewing MySQL logs
+Container shell access and viewing MySQL logs
+---------------------------------------------
 
 The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `%%REPO%%` container:
 
-	docker exec -it some-%%REPO%% bash
+```
+docker exec -it some-%%REPO%% bash
+```
 
 The MySQL Server log is available through Docker's container log:
 
-	docker logs some-%%REPO%%
+```
+docker logs some-%%REPO%%
+```
 
-## Using a custom MySQL configuration file
+Using a custom MySQL configuration file
+---------------------------------------
 
 The MySQL startup configuration is specified in the file `/etc/mysql/my.cnf`. If you want to customize this configuration for your own purposes, you can create your alternative configuration file in a directory on the host machine and then mount this file in the appropriate location inside the `%%REPO%%` container, effectively replacing the standard configuration file.
 
 If you want to base your changes on the standard configuration file, start your `%%REPO` container in the standard way described above, then do:
 
-	docker exec -it some-%%REPO%% cat /etc/mysql/my.cnf > /my/custom/config-file
+```
+docker exec -it some-%%REPO%% cat /etc/mysql/my.cnf > /my/custom/config-file
+```
 
 ... where `/my/custom/config-file` is the path and name of the new configuration file. Then start a new `%%REPO%%` container like this:
 
-	docker run --name new-conf-%%REPO%% -v /my/custom/config-file:/etc/mysql/my.cnf -e MYSQL_ROOT_PASSWORD=my-secret-pw -d %%REPO%%:tag
+```
+docker run --name new-conf-%%REPO%% -v /my/custom/config-file:/etc/mysql/my.cnf -e MYSQL_ROOT_PASSWORD=my-secret-pw -d %%REPO%%:tag
+```
 
 This will start a new container `new-conf-%%REPO%%` where the MySQL instance uses the startup options specified in `/my/custom/config-file`.
 
 Note that users on host systems with SELinux enabled may see issues with this. The current workaround is to assign the relevant SELinux policy type to your new config file so that the container will be allowed to mount it:
 
-	chcon -Rt svirt_sandbox_file_t /my/custom/config-file
+```
+chcon -Rt svirt_sandbox_file_t /my/custom/config-file
+```
 
-## Environment Variables
+Environment Variables
+---------------------
 
 When you start the `%%REPO%%` image, you can adjust the configuration of the MySQL instance by passing one or more environment variables on the `docker run` command line. Do note that none of the variables below will have any effect if you start the container with a data directory that already contains a database: any pre-existing database will always be left untouched on container startup.
 
-## `MYSQL_ROOT_PASSWORD`
+### `MYSQL_ROOT_PASSWORD`
 
 This variable is mandatory and specifies the password that will be set for the MySQL `root` superuser account. In the above example, it was set to `my-secret-pw`.
 
@@ -82,9 +106,11 @@ Do note that there is no need to use this mechanism to create the root superuser
 
 This is an optional variable. Set to `yes` to allow the container to be started with a blank password for the root user. *NOTE*: Setting this variable to `yes` is not recommended unless you really know what you are doing, since this will leave your MySQL instance completely unprotected, allowing anyone to gain complete superuser access.
 
-# Caveats
+Caveats
+=======
 
-## Where to Store Data
+Where to Store Data
+-------------------
 
 Important note: There are several ways to store data used by applications that run in Docker containers. We encourage users of the `%%REPO%%` images to familiarize themselves with the options available, including:
 
@@ -94,20 +120,26 @@ Important note: There are several ways to store data used by applications that r
 The Docker documentation is a good starting point for understanding the different storage options and variations, and there are multiple blogs and forum postings that discuss and give advice in this area. We will simply show the basic procedure here for the latter option above:
 
 1.	Create a data directory on a suitable volume on your host system, e.g. `/my/own/datadir`.
-2.  Start your `%%REPO%%` container like this:
+2.	Start your `%%REPO%%` container like this:
 
-		docker run --name some-%%REPO%% -v /my/own/datadir:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d %%REPO%%:tag
+	```
+	docker run --name some-%%REPO%% -v /my/own/datadir:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d %%REPO%%:tag
+	```
 
 The `-v /my/own/datadir:/var/lib/mysql` part of the command mounts the `/my/own/datadir` directory from the underlying host system as `/var/lib/mysql` inside the container, where MySQL by default will write its data files.
 
 Note that users on host systems with SELinux enabled may see issues with this. The current workaround is to assign the relevant SELinux policy type to the new data directory so that the container will be allowed to access it:
 
-	chcon -Rt svirt_sandbox_file_t /my/own/datadir
+```
+chcon -Rt svirt_sandbox_file_t /my/own/datadir
+```
 
-## No connections until MySQL init completes
+No connections until MySQL init completes
+-----------------------------------------
 
 If there is no database initialized when the container starts, then a default database will be created. While this is the expected behavior, this means that it will not accept incoming connections until such initialization completes. This may cause issues when using automation tools, such as `docker-compose`, which start several containers simultaneously.
 
-## Usage against an existing database
+Usage against an existing database
+----------------------------------
 
 If you start your `%%REPO%%` container instance with a data directory that already contains a database (specifically, a `mysql` subdirectory), the `$MYSQL_ROOT_PASSWORD` variable should be omitted from the run command line; it will in any case be ignored, and the pre-existing database will not be changed in any way.