You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@mesos.apache.org by Greg Mann <gr...@mesosphere.io> on 2016/01/29 03:17:50 UTC
Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/
-----------------------------------------------------------
Review request for mesos and Vinod Kone.
Bugs: MESOS-4298
https://issues.apache.org/jira/browse/MESOS-4298
Repository: mesos
Description
-------
Synchronized 'configuration.md' with the 'flags.cpp' files.
Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
Diffs
-----
docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
Diff: https://reviews.apache.org/r/42939/diff/
Testing
-------
Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
Thanks,
Greg Mann
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
> On Jan. 29, 2016, 5:56 p.m., Joseph Wu wrote:
> > docs/configuration.md, lines 350-352
> > <https://reviews.apache.org/r/42939/diff/2/?file=1225522#file1225522line350>
> >
> > Does this render correctly for you? Adjacent `<code>` blocks are rendered inline.
Good catch, thanks Joseph!
- Greg
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/#review116967
-----------------------------------------------------------
On Jan. 29, 2016, 7:16 p.m., Greg Mann wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/42939/
> -----------------------------------------------------------
>
> (Updated Jan. 29, 2016, 7:16 p.m.)
>
>
> Review request for mesos and Vinod Kone.
>
>
> Bugs: MESOS-4298
> https://issues.apache.org/jira/browse/MESOS-4298
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Synchronized 'configuration.md' with the 'flags.cpp' files.
>
> Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
>
>
> Diffs
> -----
>
> docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
>
> Diff: https://reviews.apache.org/r/42939/diff/
>
>
> Testing
> -------
>
> Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
>
>
> Thanks,
>
> Greg Mann
>
>
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Joseph Wu <jo...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/#review116967
-----------------------------------------------------------
A couple of fixes you can make to the help strings and then auto-generate to this review:
docs/configuration.md (line 50)
<https://reviews.apache.org/r/42939/#comment178044>
Consider surrounding all these flags with `<code>` blocks.
docs/configuration.md (line 263)
<https://reviews.apache.org/r/42939/#comment178039>
Remove the extra "Defaults to..."?
docs/configuration.md (lines 277 - 278)
<https://reviews.apache.org/r/42939/#comment178038>
Do you want to add a `<p/>` here (as an automatic replacement for "\n\n")? The space here has no effect on the rendered text; and the resulting paragraph is somewhat harder to read.
docs/configuration.md (line 280)
<https://reviews.apache.org/r/42939/#comment178040>
Remove extra default?
docs/configuration.md (line 325)
<https://reviews.apache.org/r/42939/#comment178041>
Do you want to retain the spacing and the boldness?
docs/configuration.md (lines 344 - 346)
<https://reviews.apache.org/r/42939/#comment178043>
Does this render correctly for you? Adjacent `<code>` blocks are rendered inline.
- Joseph Wu
On Jan. 29, 2016, 9:41 a.m., Greg Mann wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/42939/
> -----------------------------------------------------------
>
> (Updated Jan. 29, 2016, 9:41 a.m.)
>
>
> Review request for mesos and Vinod Kone.
>
>
> Bugs: MESOS-4298
> https://issues.apache.org/jira/browse/MESOS-4298
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Synchronized 'configuration.md' with the 'flags.cpp' files.
>
> Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
>
>
> Diffs
> -----
>
> docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
>
> Diff: https://reviews.apache.org/r/42939/diff/
>
>
> Testing
> -------
>
> Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
>
>
> Thanks,
>
> Greg Mann
>
>
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/
-----------------------------------------------------------
(Updated Jan. 29, 2016, 9:31 p.m.)
Review request for mesos and Vinod Kone.
Changes
-------
removed dangling "depends on" link -- @vinodkone
Bugs: MESOS-4298
https://issues.apache.org/jira/browse/MESOS-4298
Repository: mesos
Description
-------
Synchronized 'configuration.md' with the 'flags.cpp' files.
Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
Diffs
-----
docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
Diff: https://reviews.apache.org/r/42939/diff/
Testing
-------
Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
Thanks,
Greg Mann
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/
-----------------------------------------------------------
(Updated Jan. 29, 2016, 8:18 p.m.)
Review request for mesos and Vinod Kone.
Bugs: MESOS-4298
https://issues.apache.org/jira/browse/MESOS-4298
Repository: mesos
Description
-------
Synchronized 'configuration.md' with the 'flags.cpp' files.
Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
Diffs (updated)
-----
docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
Diff: https://reviews.apache.org/r/42939/diff/
Testing
-------
Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
Thanks,
Greg Mann
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/
-----------------------------------------------------------
(Updated Jan. 29, 2016, 8:13 p.m.)
Review request for mesos and Vinod Kone.
Bugs: MESOS-4298
https://issues.apache.org/jira/browse/MESOS-4298
Repository: mesos
Description
-------
Synchronized 'configuration.md' with the 'flags.cpp' files.
Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
Diffs
-----
docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
Diff: https://reviews.apache.org/r/42939/diff/
Testing
-------
Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
Thanks,
Greg Mann
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/
-----------------------------------------------------------
(Updated Jan. 29, 2016, 8:02 p.m.)
Review request for mesos and Vinod Kone.
Changes
-------
Added boldface.
Bugs: MESOS-4298
https://issues.apache.org/jira/browse/MESOS-4298
Repository: mesos
Description
-------
Synchronized 'configuration.md' with the 'flags.cpp' files.
Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
Diffs (updated)
-----
docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
Diff: https://reviews.apache.org/r/42939/diff/
Testing
-------
Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
Thanks,
Greg Mann
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
> On Jan. 29, 2016, 7:52 p.m., Vinod Kone wrote:
> > My only question is about line wrapping. Doesn't seem to be consistent across the file. Is the plan to wrap them all at 80 chars?
The current wrapping is based on the help strings found in the various `flags.cpp` files. Backticks are converted to `<code></code>` tags, which leads to some lines running over 80 characters.
- Greg
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/#review116994
-----------------------------------------------------------
On Jan. 29, 2016, 8:18 p.m., Greg Mann wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/42939/
> -----------------------------------------------------------
>
> (Updated Jan. 29, 2016, 8:18 p.m.)
>
>
> Review request for mesos and Vinod Kone.
>
>
> Bugs: MESOS-4298
> https://issues.apache.org/jira/browse/MESOS-4298
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Synchronized 'configuration.md' with the 'flags.cpp' files.
>
> Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
>
>
> Diffs
> -----
>
> docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
>
> Diff: https://reviews.apache.org/r/42939/diff/
>
>
> Testing
> -------
>
> Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
>
>
> Thanks,
>
> Greg Mann
>
>
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Vinod Kone <vi...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/#review116994
-----------------------------------------------------------
Fix it, then Ship it!
My only question is about line wrapping. Doesn't seem to be consistent across the file. Is the plan to wrap them all at 80 chars?
docs/configuration.md (line 1159)
<https://reviews.apache.org/r/42939/#comment178068>
60s?
- Vinod Kone
On Jan. 29, 2016, 7:16 p.m., Greg Mann wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/42939/
> -----------------------------------------------------------
>
> (Updated Jan. 29, 2016, 7:16 p.m.)
>
>
> Review request for mesos and Vinod Kone.
>
>
> Bugs: MESOS-4298
> https://issues.apache.org/jira/browse/MESOS-4298
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Synchronized 'configuration.md' with the 'flags.cpp' files.
>
> Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
>
>
> Diffs
> -----
>
> docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
>
> Diff: https://reviews.apache.org/r/42939/diff/
>
>
> Testing
> -------
>
> Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
>
>
> Thanks,
>
> Greg Mann
>
>
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/
-----------------------------------------------------------
(Updated Jan. 29, 2016, 7:16 p.m.)
Review request for mesos and Vinod Kone.
Changes
-------
Changed flag order, edited to improve HTML rendering.
Bugs: MESOS-4298
https://issues.apache.org/jira/browse/MESOS-4298
Repository: mesos
Description
-------
Synchronized 'configuration.md' with the 'flags.cpp' files.
Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
Diffs (updated)
-----
docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
Diff: https://reviews.apache.org/r/42939/diff/
Testing
-------
Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
Thanks,
Greg Mann
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/
-----------------------------------------------------------
(Updated Jan. 29, 2016, 5:41 p.m.)
Review request for mesos and Vinod Kone.
Bugs: MESOS-4298
https://issues.apache.org/jira/browse/MESOS-4298
Repository: mesos
Description
-------
Synchronized 'configuration.md' with the 'flags.cpp' files.
Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
Diffs (updated)
-----
docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
Diff: https://reviews.apache.org/r/42939/diff/
Testing
-------
Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
Thanks,
Greg Mann
Re: Review Request 42939: Synchronized 'configuration.md' with the
'flags.cpp' files.
Posted by Greg Mann <gr...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/42939/
-----------------------------------------------------------
(Updated Jan. 29, 2016, 5:25 a.m.)
Review request for mesos and Vinod Kone.
Bugs: MESOS-4298
https://issues.apache.org/jira/browse/MESOS-4298
Repository: mesos
Description
-------
Synchronized 'configuration.md' with the 'flags.cpp' files.
Programatically generated HTML from the flag help strings and imported that text into 'configuration.md', thus synchronizing the documentation with the source code.
Diffs (updated)
-----
docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29
Diff: https://reviews.apache.org/r/42939/diff/
Testing
-------
Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
Thanks,
Greg Mann