mbox series

[0/2] Cleanup fit documentation

Message ID 20240604195256.1820285-1-sam.povilus@amd.com
Headers show
Series Cleanup fit documentation | expand

Message

Sam Povilus June 4, 2024, 7:52 p.m. UTC
Sam Povilus (2):
  doc: Remove extraneous curly braces
  doc: add clarity to what a "fpga" image is

 doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

Comments

Simon Glass June 5, 2024, 2:13 a.m. UTC | #1
Hi Sam,

On Tue, 4 Jun 2024 at 13:53, Sam Povilus <sam.povilus@amd.com> wrote:
>
> Sam Povilus (2):
>   doc: Remove extraneous curly braces
>   doc: add clarity to what a "fpga" image is
>
>  doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
>  1 file changed, 14 insertions(+), 14 deletions(-)

This is now at [1]. Could you please instead do a PR for that?

I am not sure yet the best way to incorporate or link the FIT spec
from the U-Boot documentation. I suppose we could employ a script to
sync it?

Regards,
Simon

[1] https://github.com/open-source-firmware/flat-image-tree
Simon Glass June 5, 2024, 3:52 p.m. UTC | #2
Hi Sam,

On Tue, 4 Jun 2024 at 20:13, Simon Glass <sjg@chromium.org> wrote:
>
> Hi Sam,
>
> On Tue, 4 Jun 2024 at 13:53, Sam Povilus <sam.povilus@amd.com> wrote:
> >
> > Sam Povilus (2):
> >   doc: Remove extraneous curly braces
> >   doc: add clarity to what a "fpga" image is
> >
> >  doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
> >  1 file changed, 14 insertions(+), 14 deletions(-)
>
> This is now at [1]. Could you please instead do a PR for that?
>
> I am not sure yet the best way to incorporate or link the FIT spec
> from the U-Boot documentation. I suppose we could employ a script to
> sync it?

Hmm actually it is at [2].

So perhaps we can just link to it and drop some of the files from U-Boot?

Regards,
Simon

[2] https://fitspec.osfw.foundation/
Quentin Schulz June 6, 2024, 2:59 p.m. UTC | #3
Hi Simon,

On 6/5/24 5:52 PM, Simon Glass wrote:
> Hi Sam,
> 
> On Tue, 4 Jun 2024 at 20:13, Simon Glass <sjg@chromium.org> wrote:
>>
>> Hi Sam,
>>
>> On Tue, 4 Jun 2024 at 13:53, Sam Povilus <sam.povilus@amd.com> wrote:
>>>
>>> Sam Povilus (2):
>>>    doc: Remove extraneous curly braces
>>>    doc: add clarity to what a "fpga" image is
>>>
>>>   doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
>>>   1 file changed, 14 insertions(+), 14 deletions(-)
>>
>> This is now at [1]. Could you please instead do a PR for that?
>>
>> I am not sure yet the best way to incorporate or link the FIT spec
>> from the U-Boot documentation. I suppose we could employ a script to
>> sync it?
> 

One can reference links from another Sphinx project thanks to 
intersphinx_mapping, c.f. 
https://git.yoctoproject.org/yocto-docs/tree/documentation/conf.py#n114 
and 
https://git.yoctoproject.org/yocto-docs/tree/documentation/migration-guides/release-notes-5.0.rst#n196.

It requires the objects.inv file to be available, which seems to be the 
case.

Hope this helps,
Cheers,
Quentin