[gmx-developers] gromacs.org_gmx-developers Digest, Vol 171, Issue 12

[Mark Abraham]

Hi,

On Wed, Aug 1, 2018 at 2:41 PM Eric Irrgang <ericirrgang at gmail.com> wrote:

> > I'm sure there are ways to improve things here, and the more important
> > thing is to write words than worry about where to host them. Do note that
> > there are things in the developer guide in the source repo, which we
> should
> > not duplicate!
>
> Mark: I'm sorry, but your last comment is not clear to me, maybe
> because it goes to my original question.
> I don't imagine you are pointing out that we shouldn't duplicate the
> source repo. (Ah, the joys of English grammar...) Do you mean we
> should not propagate the fact that things in the developer guide are
> in the source repo? Or that if some piece of information is already in
> the source repo, that it should be referenced instead of duplicated?
> Also, I think the term "developer guide" is explicitly used only in
> the Sphinx sources in the repo (also "dev manual"), but I wanted to
> double-check that this is what you mean.
>

I think it would be efficient not to spend time writing text that is
similar to text we already have. e.g. we should perhaps move and update the
existing section on uncrustify rather than write a fresh one. Or spend the
time getting clang-format to work close enough to the existing style that
we can retire uncrustify. Or adding the smarts to a Jenkins job to create a
post-uncrustify patch that can be transferred to gerrit easily.

The gist, though, seems to be that I should submit a patch to Gerrit,
> and if the content is not appropriate to port, it will be addressed in
> code review. I was hoping to get specific thumbs up or down before
> spending time on formatting, but it isn't that big a deal, so I'll
> start a patch as soon as I figure out why the webpage isn't building
> for me with Sphinx 1.7.x
>

There's probably stuff that doesn't make sense in the source repo, but it's
what we have for now until someone has time to work on the new webpage.

Mark

-- 
> Gromacs Developers mailing list
>
> * Please search the archive at
> http://www.gromacs.org/Support/Mailing_Lists/GMX-developers_List before
> posting!
>
> * Can't post? Read http://www.gromacs.org/Support/Mailing_Lists
>
> * For (un)subscribe requests visit
> https://maillist.sys.kth.se/mailman/listinfo/gromacs.org_gmx-developers
> or send a mail to gmx-developers-request at gromacs.org.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://maillist.sys.kth.se/pipermail/gromacs.org_gmx-developers/attachments/20180801/ce0d3336/attachment-0001.html>