kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity
moby--moby/man
History
Sebastiaan van Stijn ca474f7808
Fix incorrect aux-address examples and test 
The (host)name for aux-addresses should
be unique, otherwise later values overwrite
earlier values.

Before this change, the example command
would send this API request;

    {
      "Attachable": false,
      "CheckDuplicate": true,
      "Driver": "overlay",
      "EnableIPv6": false,
      "IPAM": {
        "Config": [
          {
            "Gateway": "192.168.0.100",
            "IPRange": "192.168.1.0/24",
            "Subnet": "192.168.0.0/16"
          },
          {
            "AuxiliaryAddresses": {
              "a": "192.170.1.5",
              "b": "192.170.1.6"
            },
            "Gateway": "192.170.0.100",
            "Subnet": "192.170.0.0/16"
          }
        ],
        "Driver": "default",
        "Options": {
        }
      },
      "Internal": false,
      "Labels": {
      },
      "Name": "my-multihost-network",
      "Options": {
      }
    }

After this change, the request looks
like this (all aux-addresses preserved);

    {
      "Attachable": false,
      "CheckDuplicate": true,
      "Driver": "overlay",
      "EnableIPv6": false,
      "IPAM": {
        "Config": [
          {
            "AuxiliaryAddresses": {
              "my-router": "192.168.1.5",
              "my-switch": "192.168.1.6"
            },
            "Gateway": "192.168.0.100",
            "IPRange": "192.168.1.0/24",
            "Subnet": "192.168.0.0/16"
          },
          {
            "AuxiliaryAddresses": {
              "my-printer": "192.170.1.5",
              "my-nas": "192.170.1.6"
            },
            "Gateway": "192.170.0.100",
            "Subnet": "192.170.0.0/16"
          }
        ],
        "Driver": "default",
        "Options": {
        }
      },
      "Internal": false,
      "Labels": {
      },
      "Name": "my-multihost-network",
      "Options": {
      }
    }

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit fd7161bb30)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:52 +02:00
..
docker-attach.1.md Fix a couple of typos in the docs of docker attach 2016-06-06 19:06:50 -07:00
docker-build.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01:00
docker-commit.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01:00
docker-config-json.5.md man: mv config-json.5 to docker-config-json.5 2016-06-03 15:28:19 +02:00
docker-cp.1.md update docs/reference/commandline/cp.md 2016-05-24 11:09:38 +00:00
docker-create.1.md Revert "Merge pull request #26320 from yongtang/09052016-man-docker-create" 2016-09-21 19:48:43 +02:00
docker-diff.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-events.1.md attach: replace interface with simple type 2016-06-03 16:40:43 -07:00
docker-exec.1.md Fix docs 2016-02-17 11:55:56 +08:00
docker-export.1.md various man page typos 2015-10-13 11:52:14 -04:00
docker-history.1.md remove =false from options that default to false in the docs 2015-12-23 07:11:35 -08:00
docker-images.1.md Add before and since filter to images 2016-05-25 13:49:10 +02:00
docker-import.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-info.1.md Update docker info output example 2016-06-16 23:36:56 -07:00
docker-inspect.1.md fix typos 2016-06-02 17:17:22 +08:00
docker-kill.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-load.1.md Update docker-load documentation 2016-06-08 17:40:37 +02:00
docker-login.1.md Merge pull request #26307 from AkihiroSuda/fix-doc-26291 2016-09-06 12:31:59 -07:00
docker-logout.1.md Remove some references to "register" through login 2016-03-01 17:33:23 +01:00
docker-logs.1.md Replace U+2018 and U+2019 with U+0027 in manpages 2016-05-20 20:15:57 +02:00
docker-network-connect.1.md Improve wording about re-assigning IP addresses 2016-01-27 17:11:12 +00:00
docker-network-create.1.md Fix incorrect aux-address examples and test 2016-09-29 14:28:52 +02:00
docker-network-disconnect.1.md Forced endpoint cleanup 2016-01-13 21:28:52 -08:00
docker-network-inspect.1.md Display internal flag on network inspect 2016-02-04 15:28:37 +08:00
docker-network-ls.1.md Fix incorrect help output in docker network ls 2016-09-26 19:33:52 -07:00
docker-network-rm.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-pause.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-port.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-ps.1.md add support for filtering by network ID 2016-06-07 16:50:31 +02:00
docker-pull.1.md Mention "docker login" in push/pull documentation 2016-03-28 17:22:41 -07:00
docker-push.1.md Synchronize push reference with man page 2016-09-29 14:17:37 +02:00
docker-rename.1.md Merge pull request #26224 from q384566678/test-zhou 2016-09-16 10:03:12 -07:00
docker-restart.1.md Merge pull request #26264 from q384566678/test-two 2016-09-09 14:45:22 -07:00
docker-rm.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-rmi.1.md remove =false from options that default to false in the docs 2015-12-23 07:11:35 -08:00
docker-run.1.md Fix capitalization 2016-08-17 23:22:00 +02:00
docker-save.1.md Update 'save' command help 2016-03-22 08:16:52 +01:00
docker-search.1.md Add --limit option to docker search 2016-06-02 19:12:20 -07:00
docker-start.1.md Implement configurable detach key 2016-01-03 23:03:39 +01:00
docker-stats.1.md Change HumanSize to BytesSize for memory output in docker stats. 2016-04-08 20:01:50 +00:00
docker-stop.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-tag.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01:00
docker-top.1.md Improvement of docker top Man Page 2015-12-02 18:54:52 +01:00
docker-unpause.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-update.1.md Update RestartPolicy of container 2016-02-20 17:06:32 +08:00
docker-version.1.md add --format flag to docker version 2015-07-13 19:10:56 -04:00
docker-wait.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker.1.md Update the docker daemon to dockerd for document 2016-04-29 09:06:02 +08:00
dockerd.8.md Require listen address and advertise address to be an IP address or an interface name 2016-07-25 23:18:12 -07:00
Dockerfile Fix the man/Dockerfile for arm 2016-08-11 17:56:46 -07:00
Dockerfile.5.md Clarify warning against using build-time variables for secrets 2016-07-12 15:50:21 -07:00
Dockerfile.armhf Fix the man/Dockerfile for arm 2016-08-11 17:56:46 -07:00
generate.go Add a script to generate man pages from cobra commands. 2016-07-25 23:15:42 -07:00
generate.sh Add a script to generate man pages from cobra commands. 2016-07-25 23:15:42 -07:00
glide.lock Dont run man generation as part of test-unit. 2016-07-25 23:15:42 -07:00
glide.yaml Add a script to generate man pages from cobra commands. 2016-07-25 23:15:42 -07:00
md2man-all.sh Moving man pages out of docs 2015-06-10 13:43:35 -07:00
README.md Make README less scabious 2016-07-25 23:17:01 -07:00

README.md

Docker Documentation

This directory contains scripts for generating the man pages. Many of the man pages are generated directly from the spf13/cobra Command definition. Some legacy pages are still generated from the markdown files in this directory. Do not edit the man pages in the man1 directory. Instead, update the Cobra command or amend the Markdown files for legacy pages.

Generate the man pages

From within the project root directory run:

make manpages