[PATCH] Documentation: Replace ENTRY_POINT with ENTRY_FUNCTION

[PATCH] Documentation: Replace ENTRY_POINT with ENTRY_FUNCTION

[Jules Maselbas]

I think the documentation is referring to the ENTRY_FUNCTION macro, not ENTRY_POINT

Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu>
---
 Documentation/devel/porting.rst    | 2 +-
 Documentation/user/multi-image.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devel/porting.rst b/Documentation/devel/porting.rst
index 97b787327c..5bf0b45e65 100644
--- a/Documentation/devel/porting.rst
+++ b/Documentation/devel/porting.rst
@@ -131,7 +131,7 @@ Lets look at this line by line:
  - ``ENTRY_FUNCTION(start_my_board, r0, r1, r2)``
    The entry point is special: It needs to be located at the beginning of the
    image, it does not return and may run before a stack is set up.
-   The ``ENTRY_POINT()`` macro takes care of these details and passes along
+   The ``ENTRY_FUNCTION()`` macro takes care of these details and passes along
    a number of registers, in case the Boot ROM has placed something interesting there.
 
  - ``extern char __dtb_my_board_start[];``
diff --git a/Documentation/user/multi-image.rst b/Documentation/user/multi-image.rst
index 727b98fe5a..0a7bf91a55 100644
--- a/Documentation/user/multi-image.rst
+++ b/Documentation/user/multi-image.rst
@@ -46,7 +46,7 @@ let the common binary determine the board type.
 
 The board specific PBL images are generated from a single set of object files
 using the linker. The basic trick here is that the PBL objects have multiple
-entry points, specified with the ENTRY_POINT macro. For each PBL binary
+entry points, specified with the ENTRY_FUNCTION macro. For each PBL binary
 generated a different entry point is selected using the ``-e`` option to ld.
 The linker will throw away all unused entry points and only keep the functions
 used by a particular entry point.
-- 
2.17.1


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH] Documentation: Typo fix in command example

[Jules Maselbas]

The ``make`` command is missing a closing angle bracket ``>``.

Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu>
---
 Documentation/user/multi-image.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/user/multi-image.rst b/Documentation/user/multi-image.rst
index 0a7bf91a55..374b79f91b 100644
--- a/Documentation/user/multi-image.rst
+++ b/Documentation/user/multi-image.rst
@@ -51,4 +51,4 @@ generated a different entry point is selected using the ``-e`` option to ld.
 The linker will throw away all unused entry points and only keep the functions
 used by a particular entry point.
 
-The Multi Image PBL files can be disassembled with ``make <entry-function-name.pbl.S``
+The Multi Image PBL files can be disassembled with ``make <entry-function-name>.pbl.S``
-- 
2.17.1


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: [PATCH] Documentation: Typo fix in command example

[Jules Maselbas]

On Tue, Sep 07, 2021 at 03:01:31PM +0200, Jules Maselbas wrote:
> The ``make`` command is missing a closing angle bracket ``>``.
> 
> Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu>
> ---
>  Documentation/user/multi-image.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/user/multi-image.rst b/Documentation/user/multi-image.rst
> index 0a7bf91a55..374b79f91b 100644
> --- a/Documentation/user/multi-image.rst
> +++ b/Documentation/user/multi-image.rst
> @@ -51,4 +51,4 @@ generated a different entry point is selected using the ``-e`` option to ld.
>  The linker will throw away all unused entry points and only keep the functions
>  used by a particular entry point.
>  
> -The Multi Image PBL files can be disassembled with ``make <entry-function-name.pbl.S``
> +The Multi Image PBL files can be disassembled with ``make <entry-function-name>.pbl.S``
I think that should be: ``make images/<entry-function-name>.pbl.s`` as
mentioned in images/Makefile





_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: [PATCH] Documentation: Typo fix in command example

[Sascha Hauer]

On Wed, Sep 08, 2021 at 10:41:14AM +0200, Jules Maselbas wrote:
> On Tue, Sep 07, 2021 at 03:01:31PM +0200, Jules Maselbas wrote:
> > The ``make`` command is missing a closing angle bracket ``>``.
> > 
> > Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu>
> > ---
> >  Documentation/user/multi-image.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/user/multi-image.rst b/Documentation/user/multi-image.rst
> > index 0a7bf91a55..374b79f91b 100644
> > --- a/Documentation/user/multi-image.rst
> > +++ b/Documentation/user/multi-image.rst
> > @@ -51,4 +51,4 @@ generated a different entry point is selected using the ``-e`` option to ld.
> >  The linker will throw away all unused entry points and only keep the functions
> >  used by a particular entry point.
> >  
> > -The Multi Image PBL files can be disassembled with ``make <entry-function-name.pbl.S``
> > +The Multi Image PBL files can be disassembled with ``make <entry-function-name>.pbl.S``
> I think that should be: ``make images/<entry-function-name>.pbl.s`` as
> mentioned in images/Makefile

Indeed. Applied, thanks

Sascha

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox