diff mbox series

[1/2] docs: Update FVP_CONSOLES in runfvp documentation

Message ID 20220805144756.2492832-1-peter.hoyes@arm.com
State New
Headers show
Series [1/2] docs: Update FVP_CONSOLES in runfvp documentation | expand

Commit Message

Peter Hoyes Aug. 5, 2022, 2:47 p.m. UTC 
From: Peter Hoyes <Peter.Hoyes@arm.com>

The runfvp refactor to enable OEFVPSerialTarget created FVP_CONSOLES
which maps the names used for serial ports in test cases to the names
used for serial ports in the FVP stdout.

Refactor the FVP_CONSOLE section -> FVP_CONSOLES, noting the the
'default' console is still used for the --console runfvp flag.

Issue-Id: SCM-4954
Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
Change-Id: Ieb13d74cfd425900f44b4b2e6d125393e7b456ad
---
 documentation/runfvp.md | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

Comments

Jon Mason Aug. 8, 2022, 7:33 p.m. UTC | #1 
On Fri, 5 Aug 2022 15:47:55 +0100, Peter Hoyes wrote:
> The runfvp refactor to enable OEFVPSerialTarget created FVP_CONSOLES
> which maps the names used for serial ports in test cases to the names
> used for serial ports in the FVP stdout.
> 
> Refactor the FVP_CONSOLE section -> FVP_CONSOLES, noting the the
> 'default' console is still used for the --console runfvp flag.

Applied, thanks!

[1/2] docs: Update FVP_CONSOLES in runfvp documentation
      commit: 74a36b024f4d20c80e7c686cdc6d829d60a2689d
[2/2] docs: Introduce meta-arm OEQA documentation
      commit: f83aad2ba9d43327bcae28b6c05a8a8ab9d5a519

Best regards,
Peter Hoyes Aug. 9, 2022, 8:44 a.m. UTC | #2 
On 08/08/2022 20:33, Jon Mason wrote:
> On Fri, 5 Aug 2022 15:47:55 +0100, Peter Hoyes wrote:
>> The runfvp refactor to enable OEFVPSerialTarget created FVP_CONSOLES
>> which maps the names used for serial ports in test cases to the names
>> used for serial ports in the FVP stdout.
>>
>> Refactor the FVP_CONSOLE section -> FVP_CONSOLES, noting the the
>> 'default' console is still used for the --console runfvp flag.
> Applied, thanks!
>
> [1/2] docs: Update FVP_CONSOLES in runfvp documentation
>        commit: 74a36b024f4d20c80e7c686cdc6d829d60a2689d
> [2/2] docs: Introduce meta-arm OEQA documentation
>        commit: f83aad2ba9d43327bcae28b6c05a8a8ab9d5a519
>
> Best regards,
Please can this chain be backported to kirkstone.
Jon Mason Aug. 9, 2022, 3:26 p.m. UTC | #3 
On Tue, Aug 09, 2022 at 09:44:20AM +0100, Peter Hoyes wrote:
> On 08/08/2022 20:33, Jon Mason wrote:
> > On Fri, 5 Aug 2022 15:47:55 +0100, Peter Hoyes wrote:
> > > The runfvp refactor to enable OEFVPSerialTarget created FVP_CONSOLES
> > > which maps the names used for serial ports in test cases to the names
> > > used for serial ports in the FVP stdout.
> > > 
> > > Refactor the FVP_CONSOLE section -> FVP_CONSOLES, noting the the
> > > 'default' console is still used for the --console runfvp flag.
> > Applied, thanks!
> > 
> > [1/2] docs: Update FVP_CONSOLES in runfvp documentation
> >        commit: 74a36b024f4d20c80e7c686cdc6d829d60a2689d
> > [2/2] docs: Introduce meta-arm OEQA documentation
> >        commit: f83aad2ba9d43327bcae28b6c05a8a8ab9d5a519
> > 
> > Best regards,
> Please can this chain be backported to kirkstone.
> 
Done
diff mbox series

Patch

diff --git a/documentation/runfvp.md b/documentation/runfvp.md
index b9e007b..c792f4e 100644
--- a/documentation/runfvp.md
+++ b/documentation/runfvp.md
@@ -98,13 +98,16 @@  FVP_TERMINALS[bp.terminal_2] = ""
 FVP_TERMINALS[bp.terminal_3] = ""
 ```
 
-### `FVP_CONSOLE`
+### `FVP_CONSOLES`
 
-This specifies what serial port is used when `--console` is passed to runfvp. Note that this has to be the FVP identifier but without the board prefix, for example:
+This specifies what serial ports can be used in oeqa tests, along with an alias to be used in the test cases. Note that the values have to be the FVP identifier but without the board prefix, for example:
 ```
-FVP_CONSOLE = "terminal_0"
+FVP_CONSOLES[default] = "terminal_0"
+FVP_CONSOLES[tf-a] = "s_terminal_0"
 ```
 
+The 'default' console is also used when `--console` is passed to runfvp.
+
 ### `FVP_EXTRA_ARGS`
 
 Arbitrary extra arguments that are passed directly to the FVP.  For example: