diff mbox series

doc: rockchip: Update documentation with Rock Pi 4

Message ID 20200519184509.21729-1-walter.lozano@collabora.com
State Superseded
Delegated to: Kever Yang
Headers show
Series doc: rockchip: Update documentation with Rock Pi 4 | expand

Commit Message

Walter Lozano May 19, 2020, 6:45 p.m. UTC
Update README.rockchip to reflect the support of Radxa Rock Pi 4

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>
---
 doc/README.rockchip | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Jagan Teki May 19, 2020, 6:57 p.m. UTC | #1
On Wed, May 20, 2020 at 12:15 AM Walter Lozano
<walter.lozano@collabora.com> wrote:
>
> Update README.rockchip to reflect the support of Radxa Rock Pi 4
>
> Signed-off-by: Walter Lozano <walter.lozano@collabora.com>
> ---
>  doc/README.rockchip | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)

We have doc/board/rockchip please update there.

Jagan.
Walter Lozano May 19, 2020, 8:29 p.m. UTC | #2
Hi Jagan

On 19/5/20 15:57, Jagan Teki wrote:
> On Wed, May 20, 2020 at 12:15 AM Walter Lozano
> <walter.lozano@collabora.com> wrote:
>> Update README.rockchip to reflect the support of Radxa Rock Pi 4
>>
>> Signed-off-by: Walter Lozano <walter.lozano@collabora.com>
>> ---
>>   doc/README.rockchip | 3 ++-
>>   1 file changed, 2 insertions(+), 1 deletion(-)
> We have doc/board/rockchip please update there.

Documentation in doc/board/rockchip already states the support for Radxa 
Rock Pi 4. Unfortunately having two different documentation which 
overlaps tends to be redundancy prone.


At this point I think that the best approach it to spawn two tasks

1- Update the doc/README.rockchip with any specific information which 
needs to be updated

2- Continue to move doc/README.rockchip to doc/board/rockchip as you 
started to do


I might find some time to work in task 2, but in the meantime I think 
this patch goes in the direction of task 1


Do you agree?


Regards,


Walter
Tom Rini May 19, 2020, 9:02 p.m. UTC | #3
On Tue, May 19, 2020 at 05:29:31PM -0300, Walter Lozano wrote:
> Hi Jagan
> 
> On 19/5/20 15:57, Jagan Teki wrote:
> > On Wed, May 20, 2020 at 12:15 AM Walter Lozano
> > <walter.lozano@collabora.com> wrote:
> > > Update README.rockchip to reflect the support of Radxa Rock Pi 4
> > > 
> > > Signed-off-by: Walter Lozano <walter.lozano@collabora.com>
> > > ---
> > >   doc/README.rockchip | 3 ++-
> > >   1 file changed, 2 insertions(+), 1 deletion(-)
> > We have doc/board/rockchip please update there.
> 
> Documentation in doc/board/rockchip already states the support for Radxa
> Rock Pi 4. Unfortunately having two different documentation which overlaps
> tends to be redundancy prone.
> 
> 
> At this point I think that the best approach it to spawn two tasks
> 
> 1- Update the doc/README.rockchip with any specific information which needs
> to be updated
> 
> 2- Continue to move doc/README.rockchip to doc/board/rockchip as you started
> to do
> 
> 
> I might find some time to work in task 2, but in the meantime I think this
> patch goes in the direction of task 1
> 
> 
> Do you agree?

I'd like to see doc/README.rockchip go away in favour of
doc/board/rockchip/ as soon as possible, especially since this is an
area with active development.  I'd rather see an update to
doc/README.rockchip saying that doc/board/rockchip/rockchip.rst has the
list of supported hardware as the step forward here.  Thanks!
Walter Lozano May 19, 2020, 9:06 p.m. UTC | #4
Hi Tom,

On 19/5/20 18:02, Tom Rini wrote:
> On Tue, May 19, 2020 at 05:29:31PM -0300, Walter Lozano wrote:
>> Hi Jagan
>>
>> On 19/5/20 15:57, Jagan Teki wrote:
>>> On Wed, May 20, 2020 at 12:15 AM Walter Lozano
>>> <walter.lozano@collabora.com> wrote:
>>>> Update README.rockchip to reflect the support of Radxa Rock Pi 4
>>>>
>>>> Signed-off-by: Walter Lozano <walter.lozano@collabora.com>
>>>> ---
>>>>    doc/README.rockchip | 3 ++-
>>>>    1 file changed, 2 insertions(+), 1 deletion(-)
>>> We have doc/board/rockchip please update there.
>> Documentation in doc/board/rockchip already states the support for Radxa
>> Rock Pi 4. Unfortunately having two different documentation which overlaps
>> tends to be redundancy prone.
>>
>>
>> At this point I think that the best approach it to spawn two tasks
>>
>> 1- Update the doc/README.rockchip with any specific information which needs
>> to be updated
>>
>> 2- Continue to move doc/README.rockchip to doc/board/rockchip as you started
>> to do
>>
>>
>> I might find some time to work in task 2, but in the meantime I think this
>> patch goes in the direction of task 1
>>
>>
>> Do you agree?
> I'd like to see doc/README.rockchip go away in favour of
> doc/board/rockchip/ as soon as possible, especially since this is an
> area with active development.  I'd rather see an update to
> doc/README.rockchip saying that doc/board/rockchip/rockchip.rst has the
> list of supported hardware as the step forward here.  Thanks!
>
OK, it makes sense. I'll prepare such patch and send it.

Regards,

Walter
diff mbox series

Patch

diff --git a/doc/README.rockchip b/doc/README.rockchip
index 70c8798ed2..c6718e83c7 100644
--- a/doc/README.rockchip
+++ b/doc/README.rockchip
@@ -59,7 +59,7 @@  Three RK3328 boards are supported:
    - Firefly / Libre Computer Project ROC-RK3328-CC board -
      use roc-cc-rk3328_defconfig
 
-Size RK3399 boards are supported (aarch64):
+Seven RK3399 boards are supported (aarch64):
 
    - EBV RK3399 - use evb_rk3399 configuration
    - Firefly RK3399 - use the firefly_rk3399 configuration
@@ -67,6 +67,7 @@  Size RK3399 boards are supported (aarch64):
    - Ficus - use ficus-rk3399 configuration
    - Rock960 (Vamrs) - use rock960-rk3399 configuration
    - Bob - use chromebook_bob configuration
+   - Radxa Rock Pi 4 - use rock-pi-4-rk3399_defconfig
 
 Four RK3368 boards are supported: