Skip to content

docs: container logs: add headers for flags#7003

Open
thaJeztah wants to merge 1 commit into
docker:masterfrom
thaJeztah:logs_links
Open

docs: container logs: add headers for flags#7003
thaJeztah wants to merge 1 commit into
docker:masterfrom
thaJeztah:logs_links

Conversation

@thaJeztah
Copy link
Copy Markdown
Member

Add separate headers for each flag, so that they can be linked from the flag-description table.

- What I did

- How I did it

- How to verify it

- Human readable description for the release notes

- A picture of a cute animal (not mandatory but encouraged)

Comment on lines +33 to +44
### <a name="follow"></a> Stream log output (-f, --follow)

The `docker logs --follow` command will continue streaming the new output from
the container's `STDOUT` and `STDERR`.

### <a name="tail"></a> Retrieve the last logs (-n, --tail)

Passing a negative number or a non-integer to `--tail` is invalid and the
value is set to `all` in that case.


### <a name="timestamps"></a> Retrieve logs with timestamps (-t, --timestamps)
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all needs a bit of a rewrite as the wording is pretty poor; this PR is keeping the changes minimal; just adding the headings.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Add separate headers for each flag, so that they can be linked from
the flag-description table.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants