Skip to content

Comments

Generate CLI pages automatically#2068

Merged
dlang-bot merged 4 commits intodlang:masterfrom
wilzbach:docs
Feb 7, 2018
Merged

Generate CLI pages automatically#2068
dlang-bot merged 4 commits intodlang:masterfrom
wilzbach:docs

Conversation

@wilzbach
Copy link
Contributor

@wilzbach wilzbach commented Jan 9, 2018

TODO:

@dlang-bot
Copy link
Contributor

Thanks for your pull request, @wilzbach!

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

@wilzbach
Copy link
Contributor Author

wilzbach commented Feb 3, 2018

Rebased again. How perfect does this initial version need to be?

@CyberShadow
Copy link
Member

The HTML is looking pretty broken. In the new version, e.g. on the FreeBSD page, the "Requirements and Downloads" section, has a numbered list that's cut off and broken by the "Files" section.

@wilzbach
Copy link
Contributor Author

wilzbach commented Feb 5, 2018

Found the problem - it was a missing brace in the first commit.

@CyberShadow
Copy link
Member

@CyberShadow
Copy link
Member

Can we catch such breakages in the test phase?

@wilzbach wilzbach force-pushed the docs branch 2 times, most recently from d3a5970 to 6ed3927 Compare February 5, 2018 10:19
@wilzbach
Copy link
Contributor Author

wilzbach commented Feb 5, 2018

HTML output is still broken (on the other pages now):

Fixed.

Can we catch such breakages in the test phase?

Sure, two steps forward:

#2175 (<-- would have catched this)
#2176

Though a big step towards catching more breakage would be to detect invalid links ;-)

@CyberShadow
Copy link
Member

Some options, like -betterC and -bounscheck, have much less documentation in the new version. What's up with that? Should that extra documentation be moved to the man pages?

@wilzbach
Copy link
Contributor Author

wilzbach commented Feb 6, 2018

What's up with that?

Argh I didn't use the newly added ddoxText, but always used the man description text helpText.

@CyberShadow
Copy link
Member

HTML has duplicate IDs for switches like -debug and -debug=foo

$(LI 32 bit x86 and 64 bit x86-64 Linux operating system)

$(LI Gnu C compiler (gcc))
$(LI Gnu C compiler (gcc) or LLVM C compiler (clang))
Copy link
Member

Choose a reason for hiding this comment

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

Can clang be used for /bin/cc for linking, then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, works fine on my machine:

image

(though it would be nice to have a switch to change the linker)

Copy link
Contributor Author

@wilzbach wilzbach Feb 7, 2018

Choose a reason for hiding this comment

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

Try it yourself with:

echo 'void main(){import std.stdio; "hello".writeln;}' | CC=/usr/bin/clang dmd -v -run

@wilzbach
Copy link
Contributor Author

wilzbach commented Feb 7, 2018

HTML has duplicate IDs for switches like -debug and -debug=foo

Noted, but the browser will simply fallback to the first one:

http://dtest.dlang.io/artifact/website-8d6682e19fae73ba0d3a11bd12b7cd9a529fcc41-10ff4c70d2a4cff2151d5b48d7aa7eec/web/dmd-linux.html#switch-debug

Can I do this in a quick follow-up? @marler8997 is depending on this to add the documentation for his new -i flag...

@dlang-bot dlang-bot merged commit ffc2ea2 into dlang:master Feb 7, 2018
@wilzbach wilzbach deleted the docs branch February 7, 2018 17:08
@CyberShadow
Copy link
Member

Sorry, I didn't notice the "Blocking other work" label.

@wilzbach
Copy link
Contributor Author

wilzbach commented Feb 8, 2018

HTML has duplicate IDs for switches like -debug and -debug=foo

#2193

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.

5 participants