[27.x backport] Move dockerd man page back from docker/cli#48378
Merged
[27.x backport] Move dockerd man page back from docker/cli#48378
Conversation
Prepare to move the dockerd man page back to this repository from docker/cli, retaining history. This partially reverts commit b5579a4. Signed-off-by: Cory Snider <[email protected]> (cherry picked from commit 7d3f09a) Signed-off-by: Cory Snider <[email protected]>
This is a new option added specifically to allow for debugging of bugs in Docker's storage drivers or libdm itself. Signed-off-by: Aleksa Sarai <[email protected]> (cherry picked from commit 25baee8) Signed-off-by: Cory Snider <[email protected]>
This builds (and depends) on moby#34087 Version 2: - remove --ipc argument validation (it is now done by daemon) - add/document 'none' value - docs/reference/run.md: add a table with better modes description - dockerd(8) typesetting fixes Version 3: - remove ipc mode tests from cli/command/container/opts_test.go Signed-off-by: Kir Kolyshkin <[email protected]> (cherry picked from commit c23d4b0) Signed-off-by: Cory Snider <[email protected]>
Fix 19 typos, grammatical errors and duplicated words. These fixes have minimal impact on the code as these are either in the doc files or in comments inside the code files. Signed-off-by: Abdur Rehman <[email protected]> (cherry picked from commit 20f8455) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: Renaud Gaubert <[email protected]> (cherry picked from commit f3c3b05) Signed-off-by: Cory Snider <[email protected]>
- the `--disable-legacy-registry` daemon flag was removed - duplicate keys with conflicting values for engine labels now produce an error instead of a warning. Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 13ff896) Signed-off-by: Cory Snider <[email protected]>
…is separate commit for CLI files to address PR 36054 Signed-off-by: selansen <[email protected]> (cherry picked from commit 462f38b) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: taiji-tech <[email protected]> (cherry picked from commit 3cfa747) Signed-off-by: Cory Snider <[email protected]>
update docs based on PR 39949 Signed-off-by: Lukas Heeren <[email protected]> Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 1cbcd5d) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: Rob Gulewich <[email protected]> (cherry picked from commit 7cf2132) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: Akihiro Suda <[email protected]> (cherry picked from commit 562a6d2) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit af45195) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: Anca Iordache <[email protected]> (cherry picked from commit 6c70216) Signed-off-by: Cory Snider <[email protected]>
This removes documentation related to legacy overlay networks using an external k/v store. Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 68e9223) Signed-off-by: Cory Snider <[email protected]>
…ocumentation This fix tries to address issues raised in moby#44346. The max-concurrent-downloads and max-concurrent-uploads limits are applied for the whole engine and not for each pull/push command. Signed-off-by: Luis Henrique Mulinari <[email protected]> (cherry picked from commit a8b8f9b) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: Ashly Mathew <[email protected]> (cherry picked from commit 54971ac) Signed-off-by: Cory Snider <[email protected]>
Adds documentation for the options that were added in moby@427c7cc Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 386d0c0) Signed-off-by: Cory Snider <[email protected]>
1. Escape asterisks and underscores, that have special meaning in Markdown. While most markdown processors are smart enough to distinguish whether it's a literal * or _ or a formatting directive, escaping makes things more explicit. 2. Fix using wrong level of headings in some dm options (most are ####, but some were #####). 3. Do not use sub-heading for examples in some dm options (this is how it's done in the rest of the man page). Signed-off-by: Kir Kolyshkin <[email protected]> (cherry picked from commit 374b779) Signed-off-by: Cory Snider <[email protected]>
Mostly, this makes sure that literals (such as true, false, host, private, examples of options usage etc.) are typeset in bold, except for filenames, which are typeset in italic. While at it, - remove some default values from synopsis as it should not be there; - fix man pages references (page name in bold, volume number in regular). This is not a complete fix, but a step in the right direction. Signed-off-by: Kir Kolyshkin <[email protected]> (cherry picked from commit 690d166) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 2381219) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: David Karlsson <[email protected]> (cherry picked from commit f1ec843) Signed-off-by: Cory Snider <[email protected]>
Signed-off-by: Grace Choi <[email protected]> Signed-off-by: Pranjal Rai <[email protected]> Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit b4cee5c) Signed-off-by: Cory Snider <[email protected]>
Vendor the go-md2man tool used to generate the man pages so that the only dependency is a Go toolchain. Signed-off-by: Cory Snider <[email protected]> (cherry picked from commit 05d7008) Signed-off-by: Cory Snider <[email protected]>
Set the GO_MD2MAN make variable to elide building go-md2man from vendored sources and use the specified command instead. Signed-off-by: Cory Snider <[email protected]> (cherry picked from commit edfde78) Signed-off-by: Cory Snider <[email protected]>
tianon
approved these changes
Aug 26, 2024
vvoland
approved these changes
Aug 27, 2024
renovate bot
added a commit
to earthly/dind
that referenced
this pull request
Sep 2, 2024
This PR contains the following updates: | Package | Update | Change | |---|---|---| | [docker/docker](https://redirect.github.com/docker/docker) | minor | `27.1.2` -> `27.2.0` | --- ### Release Notes <details> <summary>docker/docker (docker/docker)</summary> ### [`v27.2.0`](https://redirect.github.com/moby/moby/releases/tag/v27.2.0) [Compare Source](https://redirect.github.com/docker/docker/compare/v27.1.2...v27.2.0-rc.1) #### 27.2.0 For a full list of pull requests and changes in this release, refer to the relevant GitHub milestones: - [docker/cli, 27.2.0 milestone](https://redirect.github.com/docker/cli/issues?q=is%3Aclosed+milestone%3A27.2.0) - [moby/moby, 27.2.0 milestone](https://redirect.github.com/moby/moby/issues?q=is%3Aclosed+milestone%3A27.2.0) - Deprecated and removed features, see [Deprecated Features](https://redirect.github.com/docker/cli/blob/v27.2.0/docs/deprecated.md). - Changes to the Engine API, see [API version history](https://redirect.github.com/moby/moby/blob/v27.2.0/docs/api/version-history.md). ##### New - CLI: Add support for device-code flow login when authenticating to the official registry. [docker/cli#5349](https://redirect.github.com/docker/cli/pull/5349) - containerd image store: `docker image ls` now supports `--tree` flag that shows a multiplatform-aware image list. This is experimental and may change at any time without any backwards compatibility. [docker/cli#5353](https://redirect.github.com/docker/cli/pull/5353) ##### API - `GET /images/json` response now includes `Manifests` field, which contains information about the sub-manifests included in the image index. This includes things like platform-specific manifests and build attestations. The new field will only be populated if the request also sets the `manifests` query parameter to `true`. > \[!WARNING] > > This is experimental and may change at any time without any backward compatibility. ##### Bug fixes and enhancements - CLI: Fix issue with remote contexts over SSH where the CLI would allocate a pseudoterminal when connecting to the remote host, which causes issues in rare situations. [docker/cli#5351](https://redirect.github.com/docker/cli/pull/5351) - Fix an issue that prevented network creation with a `--ip-range` ending on a 64-bit boundary. [moby/moby#48326](https://redirect.github.com/moby/moby/pull/48326) - CLI: IPv6 addresses shown by `docker ps` in port bindings are now bracketed. [docker/cli#5365](https://redirect.github.com/docker/cli/pull/5365) - containerd image store: Fix early error exit from `docker load` in cases where unpacking the image would fail. [moby/moby#48376](https://redirect.github.com/moby/moby/pull/48376) - containerd image store: Fix the previous image not being persisted as dangling after `docker pull`. [moby/moby#48380](https://redirect.github.com/moby/moby/pull/48380) ##### Packaging updates - Update BuildKit to [v0.15.2](https://redirect.github.com/moby/buildkit/releases/tag/v0.15.2). [moby/moby#48341](https://redirect.github.com/moby/moby/pull/48341) - Update Compose to [v2.29.2](https://redirect.github.com/docker/compose/releases/tag/v2.29.2). [docker/docker-ce-packaging#1050](https://redirect.github.com/docker/docker-ce-packaging/pull/1050) - The canonical source for the dockerd(8) man page has been moved back to the same source tree as dockerd itself. [moby/moby#48378](https://redirect.github.com/moby/moby/pull/48378) - Update containerd to [v1.7.21](https://redirect.github.com/containerd/containerd/releases/tag/v1.7.21). [moby/moby#48383](https://redirect.github.com/moby/moby/pull/48383), [docker/containerd-packaging#389](https://redirect.github.com/docker/containerd-packaging/pull/389) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6am on monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/earthly/dind). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC41OS4yIiwidXBkYXRlZEluVmVyIjoiMzguNTkuMiIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsicmVub3ZhdGUiXX0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
renovate bot
added a commit
to earthly/dind
that referenced
this pull request
Sep 2, 2024
This PR contains the following updates: | Package | Update | Change | |---|---|---| | [docker/docker](https://redirect.github.com/docker/docker) | minor | `27.1.2` -> `27.2.0` | --- ### Release Notes <details> <summary>docker/docker (docker/docker)</summary> ### [`v27.2.0`](https://redirect.github.com/moby/moby/releases/tag/v27.2.0) [Compare Source](https://redirect.github.com/docker/docker/compare/v27.1.2...v27.2.0-rc.1) #### 27.2.0 For a full list of pull requests and changes in this release, refer to the relevant GitHub milestones: - [docker/cli, 27.2.0 milestone](https://redirect.github.com/docker/cli/issues?q=is%3Aclosed+milestone%3A27.2.0) - [moby/moby, 27.2.0 milestone](https://redirect.github.com/moby/moby/issues?q=is%3Aclosed+milestone%3A27.2.0) - Deprecated and removed features, see [Deprecated Features](https://redirect.github.com/docker/cli/blob/v27.2.0/docs/deprecated.md). - Changes to the Engine API, see [API version history](https://redirect.github.com/moby/moby/blob/v27.2.0/docs/api/version-history.md). ##### New - CLI: Add support for device-code flow login when authenticating to the official registry. [docker/cli#5349](https://redirect.github.com/docker/cli/pull/5349) - containerd image store: `docker image ls` now supports `--tree` flag that shows a multiplatform-aware image list. This is experimental and may change at any time without any backwards compatibility. [docker/cli#5353](https://redirect.github.com/docker/cli/pull/5353) ##### API - `GET /images/json` response now includes `Manifests` field, which contains information about the sub-manifests included in the image index. This includes things like platform-specific manifests and build attestations. The new field will only be populated if the request also sets the `manifests` query parameter to `true`. > \[!WARNING] > > This is experimental and may change at any time without any backward compatibility. ##### Bug fixes and enhancements - CLI: Fix issue with remote contexts over SSH where the CLI would allocate a pseudoterminal when connecting to the remote host, which causes issues in rare situations. [docker/cli#5351](https://redirect.github.com/docker/cli/pull/5351) - Fix an issue that prevented network creation with a `--ip-range` ending on a 64-bit boundary. [moby/moby#48326](https://redirect.github.com/moby/moby/pull/48326) - CLI: IPv6 addresses shown by `docker ps` in port bindings are now bracketed. [docker/cli#5365](https://redirect.github.com/docker/cli/pull/5365) - containerd image store: Fix early error exit from `docker load` in cases where unpacking the image would fail. [moby/moby#48376](https://redirect.github.com/moby/moby/pull/48376) - containerd image store: Fix the previous image not being persisted as dangling after `docker pull`. [moby/moby#48380](https://redirect.github.com/moby/moby/pull/48380) ##### Packaging updates - Update BuildKit to [v0.15.2](https://redirect.github.com/moby/buildkit/releases/tag/v0.15.2). [moby/moby#48341](https://redirect.github.com/moby/moby/pull/48341) - Update Compose to [v2.29.2](https://redirect.github.com/docker/compose/releases/tag/v2.29.2). [docker/docker-ce-packaging#1050](https://redirect.github.com/docker/docker-ce-packaging/pull/1050) - The canonical source for the dockerd(8) man page has been moved back to the same source tree as dockerd itself. [moby/moby#48378](https://redirect.github.com/moby/moby/pull/48378) - Update containerd to [v1.7.21](https://redirect.github.com/containerd/containerd/releases/tag/v1.7.21). [moby/moby#48383](https://redirect.github.com/moby/moby/pull/48383), [docker/containerd-packaging#389](https://redirect.github.com/docker/containerd-packaging/pull/389) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6am on monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/earthly/dind). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC41OS4yIiwidXBkYXRlZEluVmVyIjoiMzguNTkuMiIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsicmVub3ZhdGUiXX0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
17 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
- What I did
Moved the dockerd man page back to this repo, with full history.
- How I did it
I made it self-contained by isolating the Go dependencies into a separate module and vendoring the tool sources. I put it all together with a clever Makefile.
I did not add any CI validation steps for man-page generation as it will not catch any issues with the Markdown sources.
go-md2manonly errors out if it encounters an I/O or path error.- How to verify it
From the repository root:
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)