Skip to content

Comments

Cleanup changelog#3964

Merged
schveiguy merged 2 commits intodlang:masterfrom
aG0aep6G:cleanup-changelog
Feb 9, 2016
Merged

Cleanup changelog#3964
schveiguy merged 2 commits intodlang:masterfrom
aG0aep6G:cleanup-changelog

Conversation

@aG0aep6G
Copy link
Contributor

@aG0aep6G aG0aep6G commented Feb 3, 2016

Removing old entries, fixing a link.

Copy link
Member

Choose a reason for hiding this comment

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

You sure this is how it is supposed to be? This file doesn't get built by @CyberShadow's autotester, so it's hard for me to know whether this works.

I find it hard to believe that this needs 5 parameters.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You sure this is how it is supposed to be? This file doesn't get built by @CyberShadow's autotester, so it's hard for me to know whether this works.

I've built it with dmd ../dlang.org/{std,html,dlang.org,macros}.ddoc -Dfchangelog.html changelog.dd. The page doesn't look pretty, but one can see that it generates this href:

../phobos/std_experimental_allocator_gc_allocator.html#GCAllocator.goodAllocSize

Which looks ok. Though I've just noted that it seems to miss a dot in front of "GCAllocator". But that must be fixed in the REF macro, I think.

I find it hard to believe that this needs 5 parameters.

Well, the module hierarchy is that deep and REF takes the segments individually, as it needs to join them differently two times: once with dots for the name, once with underscores for the URL.

Copy link
Member

Choose a reason for hiding this comment

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

ok.

BTW, I totally understand why very few people do anything for ddoc improvements. I have no idea how to correctly use the various macros.

This LGTM.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But that must be fixed in the REF macro, I think.

dlang/dlang.org#1223

Copy link
Contributor

Choose a reason for hiding this comment

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

The REF macro supersedes a number of less generic macros for cross-referencing. It is used correctly here.

edit: that said I don't think the inconsistent use of whitespace here is justified.

2.070 has been released, and its changelog in the dlang.org repository has
these entries.
@JakobOvrum
Copy link
Contributor

LGTM, but I have no idea how the new changelog system works. Some time ago I looked around for any info on it to no avail. It'd be a nice development if anyone with a grip on how it should be used would put it in CONTRIBUTING.md or on the Wiki.

@CyberShadow
Copy link
Member

AIUI, before a release, the release manager (Martin) essentially copies the contents of each component's changelog and pastes them in the main D changelog on the dlang.org repo.

@schveiguy
Copy link
Member

@CyberShadow that is correct

@aG0aep6G
Copy link
Contributor Author

aG0aep6G commented Feb 8, 2016

Ping? Any problems with this?

@schveiguy
Copy link
Member

I'm gonna go ahead and pull this, It's not even used until the next full release, so if there's problems they can be worked out.

Thanks.

@schveiguy
Copy link
Member

Auto-merge toggled on

schveiguy added a commit that referenced this pull request Feb 9, 2016
@schveiguy schveiguy merged commit 679298a into dlang:master Feb 9, 2016
@aG0aep6G aG0aep6G deleted the cleanup-changelog branch February 9, 2016 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants