Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make ToMarkdown and ToMan optional #1363

Closed
wants to merge 1 commit into from

Conversation

kolyshkin
Copy link
Contributor

What type of PR is this?

  • cleanup

What this PR does / why we need it:

Their functionality is not always used, and it brings in quite a big
dependency (russross/blackfriday).

Amend the documentation to make it clear that cli_docs build tag is
needed to use these functions.

This reduces runc size by about 318 Kb, or 3.4% (comparing stripped
binaries).

Which issue(s) this PR fixes:

none

Special notes for your reviewer:

none

Testing

Release Notes

Compatibility: if you are using `ToMan` or `ToMarkdown` methods, from now on
you need to add `cli_docs` build tag for your app.

@kolyshkin kolyshkin requested a review from a team as a code owner April 22, 2022 03:13
This functionality is not always used, and it brings in quite a big
dependency (russross/blackfriday).

Amend the documentation to make it clear that cli_docs build tag is
needed to use these functions.

This reduces runc size by about 318 Kb, or 3.4% (comparing stripped
binaries).

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
@meatballhat meatballhat added area/v1 relates to / is being considered for v1 kind/cleanup describes internal cleanup / maintaince labels Apr 22, 2022
@meatballhat meatballhat added this to the Release 1.22.8 milestone Apr 22, 2022
@meatballhat meatballhat changed the title [v1] Make ToMarkdown and ToMan optional Make ToMarkdown and ToMan optional Apr 22, 2022
@kolyshkin kolyshkin marked this pull request as draft April 22, 2022 03:19
@meatballhat
Copy link
Member

@kolyshkin What do you think about inverting the build constraint so that the default behavior remains the same? Is opting out of the docs bits something that can be introduced in runc (and others)?

@kolyshkin
Copy link
Contributor Author

Yes, that's possible, too. I will redo.

@kolyshkin kolyshkin closed this Apr 22, 2022
@kolyshkin
Copy link
Contributor Author

Opened #1375 as a replacement

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/v1 relates to / is being considered for v1 kind/cleanup describes internal cleanup / maintaince
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants