Project

General

Profile

Misc #13704

[PATCH] Exclude Changelog files from documentation.

Added by larskanis (Lars Kanis) almost 2 years ago. Updated over 1 year ago.

Status:
Closed
Priority:
Normal
[ruby-core:81878]

Description

The changelogs are almost 7 MBytes large, so that the ri or rdoc output is even bigger. Therefore the changelogs take almost half of the size of the entire output. However the changelog is not really valuable as part of ri or rdoc, IMHO. It may also slows down searches in rdoc.

See patch here: https://github.com/ruby/ruby/pull/1592

This issue arose originally at RubyInstaller2 and is patched there: https://github.com/oneclick/rubyinstaller2/commit/ca359aa3d827a3cbba6c715dcaeca0b03b717d62

Associated revisions

Revision 99d64640
Added by hsbt (Hiroshi SHIBATA) over 1 year ago

Exclude Changelog files from documentation.

Patch from larskanis (Lars Kanis).
[Misc #13704][ruby-core:81878]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59713 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 59713
Added by hsbt (Hiroshi SHIBATA) over 1 year ago

Exclude Changelog files from documentation.

Patch from larskanis (Lars Kanis).
[Misc #13704][ruby-core:81878]

Revision 59713
Added by hsbt (Hiroshi SHIBATA) over 1 year ago

Exclude Changelog files from documentation.

Patch from larskanis (Lars Kanis).
[Misc #13704][ruby-core:81878]

Revision 59713
Added by hsbt (Hiroshi SHIBATA) over 1 year ago

Exclude Changelog files from documentation.

Patch from larskanis (Lars Kanis).
[Misc #13704][ruby-core:81878]

History

#1

Updated by larskanis (Lars Kanis) almost 2 years ago

  • Subject changed from Exclude Changelog files from documentation. to [PATCH] Exclude Changelog files from documentation.

Updated by hsbt (Hiroshi SHIBATA) almost 2 years ago

  • Assignee set to hsbt (Hiroshi SHIBATA)
  • Status changed from Open to Assigned

I'm not sure that html page of Changelog is not valuable.

Example, permalink of changelog: https://docs.ruby-lang.org/en/2.4.0/ChangeLog-2_4_0.html#label-2016-11-07

I'm going to discuss this issue at next Developer Meeting.

#3

Updated by hsbt (Hiroshi SHIBATA) over 1 year ago

  • Status changed from Assigned to Closed

Applied in changeset trunk|r59713.


Exclude Changelog files from documentation.

Patch from larskanis (Lars Kanis).
[Misc #13704][ruby-core:81878]

Updated by hsbt (Hiroshi SHIBATA) over 1 year ago

larskanis (Lars Kanis)

We discussed this issue on Developer Meeting.
There is no objection to your request.
I'm ok to merge your patch.

Thank you.

Updated by larskanis (Lars Kanis) over 1 year ago

Nice, thank you!

Also available in: Atom PDF