From 8578a87abd23018f1c7cb07bbcb1cd8aa049fd8c Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sat, 18 May 2019 23:06:35 +0200 Subject: [PATCH 1/1] Add a link from smpirun(1) to the online doc Fix FG#3. --- ChangeLog | 1 + docs/manpages/smpirun.1 | 8 ++++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index 789eecd010..d29c3f7976 100644 --- a/ChangeLog +++ b/ChangeLog @@ -20,6 +20,7 @@ Model-checker: Fixed bugs (FG=FramaGit; GH=GitHub): - FG#1: Broken link in error messages - FG#2: missing installation documentation + - FG#3: missing documentation in smpirun - FG#7: simple cmake call requires doxygen - FG#10: Can not use MSG_process_set_data from SMPI any more - FG#11: Auto-restart actors forget their on_exit behavior diff --git a/docs/manpages/smpirun.1 b/docs/manpages/smpirun.1 index 79a804683c..5166c16113 100644 --- a/docs/manpages/smpirun.1 +++ b/docs/manpages/smpirun.1 @@ -11,7 +11,11 @@ arguments. It is intended to be easy to use to regular MPI users. .SH MANDATORY PARAMETERS .TP \fB\-platform\fR -XML file describing the platform on which we want to deploy the program +XML file describing the platform on which we want to deploy the program. +Please refer to the +.UR https://simgrid.org/doc/latest/Tutorial_MPI_Applications.html#describing-your-platform +online documentation. +.UE .TP \fB\-hostfile\fR, \fB\-machinefile\fR Hostfile listing all the machines in use @@ -21,7 +25,7 @@ be mixed with the configuration options described in the next section. .TP \fB\-help\fR -Print the usage and a résumé of the available options +Print the usage and a summary of the available options. .TP \fB\-keep-temps\fR Do not remove the generated files after execution. -- 2.20.1