Project

General

Profile

Bug #1724

membed docs missing

Added by Mark Abraham over 4 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Low
Assignee:
-
Category:
documentation
Target version:
Affected version - extra info:
All since 4.6, I think
Affected version:
Difficulty:
uncategorized
Close

Description

When we re-wrote membed to be called from mdrun, we didn't move the documentation for its command-line parameters, which I think are now read in from a file. So that code has been undocumented in 4.6 and 5.0. The former, now-unused source file that contained the docs has been deleted by 86601a237df, but that's why we have version control.

There's nowhere good to re-add such docs (mdrun -h is already too long, so there's only the PDF reference manual, if someone's keen to do it in LaTeX for 5.0), but we can add a section to docs/user-guide pretty easily for 5.1.

Associated revisions

Revision 24bc9faf (diff)
Added by Erik Lindahl over 4 years ago

Add membrane embedding docs

These were killed by mistake in 86601a237df when the
separate g_membed program was merged into mdrun.

Fixes #1724.

Change-Id: If97dbf13c269e0711cda9798fac03225920c0d6f

History

#1 Updated by Mark Abraham over 4 years ago

And while we're at it, fix the way membed refers to (at least) -maxwarn as if it is a command-line option

#2 Updated by Gerrit Code Review Bot over 4 years ago

Gerrit received a related patchset '1' for Issue #1724.
Uploader: Erik Lindahl ()
Change-Id: If97dbf13c269e0711cda9798fac03225920c0d6f
Gerrit URL: https://gerrit.gromacs.org/4714

#3 Updated by Erik Lindahl over 4 years ago

  • Status changed from New to Fix uploaded

#4 Updated by Erik Lindahl over 4 years ago

  • Status changed from Fix uploaded to Resolved

#5 Updated by Erik Lindahl over 4 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF