Re: Documentation index entries for functions

[Sebastian Huber]

On 14/10/2022 15:58, Joel Sherrill wrote:


 >
 > Which way should it be? :)

I strongly prefer the () style for functions and macros.


I should have mentioned that I also agree with this approach.

If we get a third pro-parentheses vote, I'll make a sweep.


Thanks, with the newly documented directives, there could be some 
duplicates. I work currently on the documentation of the API data 
structures, however, this is a bit of work.


--
embedded brains GmbH
Herr Sebastian HUBER
Dornierstr. 4
82178 Puchheim
Germany
email: sebastian.hu...@embedded-brains.de
phone: +49-89-18 94 741 - 16
fax:   +49-89-18 94 741 - 08

Registergericht: Amtsgericht München
Registernummer: HRB 157899
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
Unsere Datenschutzerklärung finden Sie hier:
https://embedded-brains.de/datenschutzerklaerung/
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: Documentation index entries for functions

[Chris Johns]

On 15/10/2022 12:58 am, Joel Sherrill wrote:
> On Fri, Oct 14, 2022 at 8:53 AM Sebastian Huber
>  >
> wrote:
> On 14.10.22 15:45, Joel Sherrill wrote:
> >
> > While teaching an RTEMS class this week, I noticed that rtems_build_name
> > is in the Classic API Guide index twice. Once with () and once without.
> > I started to fix that one case when I noticed that it appears we are
> > just very inconsistent.
> >
> > (rtemsdocs) [joel@localhost c-user]$ grep -r index::  | grep rtems_ |
> > grep "()$" | wc -l
> > 280
> > (rtemsdocs) [joel@localhost c-user]$ grep -r index::  | grep rtems_ |
> > grep -v "()$" | wc -l
> > 158
> >
> > There are 280 index entries with () on a method name and 158 without.
> 
> FWIW Some of the 158 without could be rtems_ data types.  
> 
> >
> > Which way should it be? :)
> 
> I strongly prefer the () style for functions and macros.
> 
> I should have mentioned that I also agree with this approach.  
> 
> If we get a third pro-parentheses vote, I'll make a sweep. 

+1

Chris
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: Documentation index entries for functions

[Joel Sherrill]

On Fri, Oct 14, 2022 at 8:53 AM Sebastian Huber <
sebastian.hu...@embedded-brains.de> wrote:

> On 14.10.22 15:45, Joel Sherrill wrote:
> >
> > While teaching an RTEMS class this week, I noticed that rtems_build_name
> > is in the Classic API Guide index twice. Once with () and once without.
> > I started to fix that one case when I noticed that it appears we are
> > just very inconsistent.
> >
> > (rtemsdocs) [joel@localhost c-user]$ grep -r index::  | grep rtems_ |
> > grep "()$" | wc -l
> > 280
> > (rtemsdocs) [joel@localhost c-user]$ grep -r index::  | grep rtems_ |
> > grep -v "()$" | wc -l
> > 158
> >
> > There are 280 index entries with () on a method name and 158 without.
>

FWIW Some of the 158 without could be rtems_ data types.

>
> > Which way should it be? :)
>
> I strongly prefer the () style for functions and macros.
>

I should have mentioned that I also agree with this approach.

If we get a third pro-parentheses vote, I'll make a sweep.

>
> --
> embedded brains GmbH
> Herr Sebastian HUBER
> Dornierstr. 4
> 82178 Puchheim
> Germany
> email: sebastian.hu...@embedded-brains.de
> phone: +49-89-18 94 741 - 16
> fax:   +49-89-18 94 741 - 08
>
> Registergericht: Amtsgericht München
> Registernummer: HRB 157899
> Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
> Unsere Datenschutzerklärung finden Sie hier:
> https://embedded-brains.de/datenschutzerklaerung/
>
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: Documentation index entries for functions

[Sebastian Huber]

On 14.10.22 15:45, Joel Sherrill wrote:


While teaching an RTEMS class this week, I noticed that rtems_build_name 
is in the Classic API Guide index twice. Once with () and once without. 
I started to fix that one case when I noticed that it appears we are 
just very inconsistent.


(rtemsdocs) [joel@localhost c-user]$ grep -r index::  | grep rtems_ | 
grep "()$" | wc -l

280
(rtemsdocs) [joel@localhost c-user]$ grep -r index::  | grep rtems_ | 
grep -v "()$" | wc -l

158

There are 280 index entries with () on a method name and 158 without.

Which way should it be? :)


I strongly prefer the () style for functions and macros.

--
embedded brains GmbH
Herr Sebastian HUBER
Dornierstr. 4
82178 Puchheim
Germany
email: sebastian.hu...@embedded-brains.de
phone: +49-89-18 94 741 - 16
fax:   +49-89-18 94 741 - 08

Registergericht: Amtsgericht München
Registernummer: HRB 157899
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
Unsere Datenschutzerklärung finden Sie hier:
https://embedded-brains.de/datenschutzerklaerung/
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Documentation index entries for functions

[Joel Sherrill]

Hi

While teaching an RTEMS class this week, I noticed that rtems_build_name is
in the Classic API Guide index twice. Once with () and once without. I
started to fix that one case when I noticed that it appears we are just
very inconsistent.

(rtemsdocs) [joel@localhost c-user]$ grep -r index::  | grep rtems_ | grep
"()$" | wc -l
280
(rtemsdocs) [joel@localhost c-user]$ grep -r index::  | grep rtems_ | grep
-v "()$" | wc -l
158

There are 280 index entries with () on a method name and 158 without.

Which way should it be? :)

--joel
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel