Re: [PATCH 1/2] Added FAQ page

[Chris Johns]

On 6/4/21 2:26 am, Gedare Bloom wrote:
> On Sat, Apr 3, 2021 at 5:15 PM Chris Johns  wrote:
>>
>> On 3/4/21 6:29 am, Gedare Bloom wrote:
>>> On Fri, Apr 2, 2021 at 12:55 PM Joel Sherrill  wrote:
 On Fri, Apr 2, 2021 at 1:50 PM Ayushman Mishra  
 wrote:
>
> Sir, It was given as an issue https://devel.rtems.org/ticket/3958 (
> Review wiki/TBR/Website/FAQ for correct links) for the faq page
> https://devel.rtems.org/wiki/TBR/Website/FAQ


 Thanks for confirming that. When Gedare acks the patches as being
 ok by him, I will see about removing that page and fixing links to it.

 --joel
>
>
>
> On Sat, Apr 3, 2021 at 12:10 AM Joel Sherrill  wrote:
>>
>>
>>
>> On Fri, Apr 2, 2021 at 1:19 PM Ayushman Mishra 
>>  wrote:
>>>
>>> Greetings Sir,
>>> I have corrected and send patches regarding FAQ page in user manual.I
>>> was able to build the page on my system and also attached a
>>> screen-shot of the builded page on browser . I have corrected
>>> whitespace consistency and reference links according to other
>>> doc-pages
>>
>>
>> Random question. Is this information from the Wiki or just an update
>> of what was already in rtems-docs? If this obsoletes any information
>> in the wiki, I would like to know so we can remove it.
>>
>>>
>>> . Regarding the issue of cross-link between docs , I had
>>> sent mail on devel mail list
>>> https://lists.rtems.org/pipermail/devel/2021-March/065882.html but
>>> haven't got any response , so few days ago after a little discussion
>>> on discord vijay sir said to post the patch and someone might point it
>>> to a better way if it exists.
>>
>>
>> I don't know if we know the answer to that with Sphinx. If "we" do, then
>> I am not part of that "we".  Hopefully someone will educate us. :)
>>
>> Gedare.. is the new patch OK? It must be in another thread because
>> I don't see it here.
>>
>> --joel
>>> Patch needs a little bit of tweaking. It's close.
>>>
>>> The problem with the cross-doc links is that they are wrong for a
>>> release doc. I don't think we have determined what is the proper
>>> solution to follow yet. They also don't populate the section numbers
>>> in PDF builds, so all you get is the URL and if you have printed
>>> manuals (does anyone do that?) you might not be able to find what you
>>> want. There's no good answer to this problem though, so I'm ok with
>>> merging the patch after the other issues get addressed, but we're
>>> probably adding more effort to the release/post-release procedures
>>> until someone sorts out how to do cross-doc links in a useful way.
>>
>> Sorry no crosslinking.
>>
> 
> This is a serious limitation that has come up several times. 

I wish I had a better answer than a flat no. I could not find a solution in
sphinx. What has been offered or added to the documentation created a liability
for the releases and so was removed. All I am doing is dealing with the issue up
front.

> We should
> open a ticket for this? Sorting out how to support link generation may
> be a worthwhile SoC task?

You would need a capable high quality GSoC student. This is a complex task. The
ticket needs to technically address how to manage the install prefix, the
supported output formats plus relative URL based web hosted installs. It has to
cover how we work checking a build without installing, installed checks (ie
coverpage) and then installs on a web server, ie docs.rtems.org and then docs on
ftp.rtems.org where the final location is not known. Can a documentation set be
moved to a new base? It happens, the old releases have moved a number of times
without being regenerated. HTML could be made to work, HTML and PDF is hard.

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

Re: [PATCH 1/2] Added FAQ page

[Gedare Bloom]

On Sat, Apr 3, 2021 at 5:15 PM Chris Johns  wrote:
>
> On 3/4/21 6:29 am, Gedare Bloom wrote:
> > On Fri, Apr 2, 2021 at 12:55 PM Joel Sherrill  wrote:
> >> On Fri, Apr 2, 2021 at 1:50 PM Ayushman Mishra  
> >> wrote:
> >>>
> >>> Sir, It was given as an issue https://devel.rtems.org/ticket/3958 (
> >>> Review wiki/TBR/Website/FAQ for correct links) for the faq page
> >>> https://devel.rtems.org/wiki/TBR/Website/FAQ
> >>
> >>
> >> Thanks for confirming that. When Gedare acks the patches as being
> >> ok by him, I will see about removing that page and fixing links to it.
> >>
> >> --joel
> >>>
> >>>
> >>>
> >>> On Sat, Apr 3, 2021 at 12:10 AM Joel Sherrill  wrote:
> 
> 
> 
>  On Fri, Apr 2, 2021 at 1:19 PM Ayushman Mishra 
>   wrote:
> >
> > Greetings Sir,
> > I have corrected and send patches regarding FAQ page in user manual.I
> > was able to build the page on my system and also attached a
> > screen-shot of the builded page on browser . I have corrected
> > whitespace consistency and reference links according to other
> > doc-pages
> 
> 
>  Random question. Is this information from the Wiki or just an update
>  of what was already in rtems-docs? If this obsoletes any information
>  in the wiki, I would like to know so we can remove it.
> 
> >
> > . Regarding the issue of cross-link between docs , I had
> > sent mail on devel mail list
> > https://lists.rtems.org/pipermail/devel/2021-March/065882.html but
> > haven't got any response , so few days ago after a little discussion
> > on discord vijay sir said to post the patch and someone might point it
> > to a better way if it exists.
> 
> 
>  I don't know if we know the answer to that with Sphinx. If "we" do, then
>  I am not part of that "we".  Hopefully someone will educate us. :)
> 
>  Gedare.. is the new patch OK? It must be in another thread because
>  I don't see it here.
> 
>  --joel
> > Patch needs a little bit of tweaking. It's close.
> >
> > The problem with the cross-doc links is that they are wrong for a
> > release doc. I don't think we have determined what is the proper
> > solution to follow yet. They also don't populate the section numbers
> > in PDF builds, so all you get is the URL and if you have printed
> > manuals (does anyone do that?) you might not be able to find what you
> > want. There's no good answer to this problem though, so I'm ok with
> > merging the patch after the other issues get addressed, but we're
> > probably adding more effort to the release/post-release procedures
> > until someone sorts out how to do cross-doc links in a useful way.
>
> Sorry no crosslinking.
>

This is a serious limitation that has come up several times. We should
open a ticket for this? Sorting out how to support link generation may
be a worthwhile SoC task?

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

Re: [PATCH 1/2] Added FAQ page

[Chris Johns]

On 3/4/21 6:29 am, Gedare Bloom wrote:
> On Fri, Apr 2, 2021 at 12:55 PM Joel Sherrill  wrote:
>> On Fri, Apr 2, 2021 at 1:50 PM Ayushman Mishra  
>> wrote:
>>>
>>> Sir, It was given as an issue https://devel.rtems.org/ticket/3958 (
>>> Review wiki/TBR/Website/FAQ for correct links) for the faq page
>>> https://devel.rtems.org/wiki/TBR/Website/FAQ
>>
>>
>> Thanks for confirming that. When Gedare acks the patches as being
>> ok by him, I will see about removing that page and fixing links to it.
>>
>> --joel
>>>
>>>
>>>
>>> On Sat, Apr 3, 2021 at 12:10 AM Joel Sherrill  wrote:



 On Fri, Apr 2, 2021 at 1:19 PM Ayushman Mishra  
 wrote:
>
> Greetings Sir,
> I have corrected and send patches regarding FAQ page in user manual.I
> was able to build the page on my system and also attached a
> screen-shot of the builded page on browser . I have corrected
> whitespace consistency and reference links according to other
> doc-pages


 Random question. Is this information from the Wiki or just an update
 of what was already in rtems-docs? If this obsoletes any information
 in the wiki, I would like to know so we can remove it.

>
> . Regarding the issue of cross-link between docs , I had
> sent mail on devel mail list
> https://lists.rtems.org/pipermail/devel/2021-March/065882.html but
> haven't got any response , so few days ago after a little discussion
> on discord vijay sir said to post the patch and someone might point it
> to a better way if it exists.


 I don't know if we know the answer to that with Sphinx. If "we" do, then
 I am not part of that "we".  Hopefully someone will educate us. :)

 Gedare.. is the new patch OK? It must be in another thread because
 I don't see it here.

 --joel
> Patch needs a little bit of tweaking. It's close.
> 
> The problem with the cross-doc links is that they are wrong for a
> release doc. I don't think we have determined what is the proper
> solution to follow yet. They also don't populate the section numbers
> in PDF builds, so all you get is the URL and if you have printed
> manuals (does anyone do that?) you might not be able to find what you
> want. There's no good answer to this problem though, so I'm ok with
> merging the patch after the other issues get addressed, but we're
> probably adding more effort to the release/post-release procedures
> until someone sorts out how to do cross-doc links in a useful way.

Sorry no crosslinking.

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

Re: [PATCH 1/2] Added FAQ page

[Chris Johns]

On 24/3/21 6:34 am, Gedare Bloom wrote:
> Did you build the docs and verify they look good?
> On Tue, Mar 23, 2021 at 12:44 PM Ayushman Mishra
>  wrote:
>> +How are floating point numbers handled ?
>> +-
>> +
>> +`Floating point support in RTEMS
>> +> +background.html#floating-point-considerations>`__
> 
> We don't like to cross-link between docs. I don't remember how this is
> handled. If you can't figure it out, you'll have to ask in an email
> how to link between different manuals in the docs.

We can not handle this type of linking. Consider a deployed version or different
formats, ie this manual is PDF in a version installed on your host and the link
takes you elsewhere to HDML that may be a different version.

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

Re: [PATCH 1/2] Added FAQ page

[Gedare Bloom]

On Fri, Apr 2, 2021 at 12:55 PM Joel Sherrill  wrote:
>
>
>
> On Fri, Apr 2, 2021 at 1:50 PM Ayushman Mishra  
> wrote:
>>
>> Sir, It was given as an issue https://devel.rtems.org/ticket/3958 (
>> Review wiki/TBR/Website/FAQ for correct links) for the faq page
>> https://devel.rtems.org/wiki/TBR/Website/FAQ
>
>
> Thanks for confirming that. When Gedare acks the patches as being
> ok by him, I will see about removing that page and fixing links to it.
>
> --joel
>>
>>
>>
>> On Sat, Apr 3, 2021 at 12:10 AM Joel Sherrill  wrote:
>> >
>> >
>> >
>> > On Fri, Apr 2, 2021 at 1:19 PM Ayushman Mishra  
>> > wrote:
>> >>
>> >> Greetings Sir,
>> >> I have corrected and send patches regarding FAQ page in user manual.I
>> >> was able to build the page on my system and also attached a
>> >> screen-shot of the builded page on browser . I have corrected
>> >> whitespace consistency and reference links according to other
>> >> doc-pages
>> >
>> >
>> > Random question. Is this information from the Wiki or just an update
>> > of what was already in rtems-docs? If this obsoletes any information
>> > in the wiki, I would like to know so we can remove it.
>> >
>> >>
>> >> . Regarding the issue of cross-link between docs , I had
>> >> sent mail on devel mail list
>> >> https://lists.rtems.org/pipermail/devel/2021-March/065882.html but
>> >> haven't got any response , so few days ago after a little discussion
>> >> on discord vijay sir said to post the patch and someone might point it
>> >> to a better way if it exists.
>> >
>> >
>> > I don't know if we know the answer to that with Sphinx. If "we" do, then
>> > I am not part of that "we".  Hopefully someone will educate us. :)
>> >
>> > Gedare.. is the new patch OK? It must be in another thread because
>> > I don't see it here.
>> >
>> > --joel
Patch needs a little bit of tweaking. It's close.

The problem with the cross-doc links is that they are wrong for a
release doc. I don't think we have determined what is the proper
solution to follow yet. They also don't populate the section numbers
in PDF builds, so all you get is the URL and if you have printed
manuals (does anyone do that?) you might not be able to find what you
want. There's no good answer to this problem though, so I'm ok with
merging the patch after the other issues get addressed, but we're
probably adding more effort to the release/post-release procedures
until someone sorts out how to do cross-doc links in a useful way.
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: [PATCH 1/2] Added FAQ page

[Joel Sherrill]

On Fri, Apr 2, 2021 at 1:50 PM Ayushman Mishra 
wrote:

> Sir, It was given as an issue https://devel.rtems.org/ticket/3958 (
> Review wiki/TBR/Website/FAQ for correct links) for the faq page
> https://devel.rtems.org/wiki/TBR/Website/FAQ


Thanks for confirming that. When Gedare acks the patches as being
ok by him, I will see about removing that page and fixing links to it.

--joel

>
>
> On Sat, Apr 3, 2021 at 12:10 AM Joel Sherrill  wrote:
> >
> >
> >
> > On Fri, Apr 2, 2021 at 1:19 PM Ayushman Mishra 
> wrote:
> >>
> >> Greetings Sir,
> >> I have corrected and send patches regarding FAQ page in user manual.I
> >> was able to build the page on my system and also attached a
> >> screen-shot of the builded page on browser . I have corrected
> >> whitespace consistency and reference links according to other
> >> doc-pages
> >
> >
> > Random question. Is this information from the Wiki or just an update
> > of what was already in rtems-docs? If this obsoletes any information
> > in the wiki, I would like to know so we can remove it.
> >
> >>
> >> . Regarding the issue of cross-link between docs , I had
> >> sent mail on devel mail list
> >> https://lists.rtems.org/pipermail/devel/2021-March/065882.html but
> >> haven't got any response , so few days ago after a little discussion
> >> on discord vijay sir said to post the patch and someone might point it
> >> to a better way if it exists.
> >
> >
> > I don't know if we know the answer to that with Sphinx. If "we" do, then
> > I am not part of that "we".  Hopefully someone will educate us. :)
> >
> > Gedare.. is the new patch OK? It must be in another thread because
> > I don't see it here.
> >
> > --joel
> >>
> >>
> >> On Wed, Mar 24, 2021 at 1:05 AM Gedare Bloom  wrote:
> >> >
> >> > Did you build the docs and verify they look good?
> >> >
> >> > On Tue, Mar 23, 2021 at 12:44 PM Ayushman Mishra
> >> >  wrote:
> >> > >
> >> > > ---
> >> > >  user/bld/index.rst   |   4 +-
> >> > >  user/overview/index.rst  |   2 +
> >> > >  user/start/faq.rst   | 255
> +++
> >> > >  user/start/index.rst |   1 +
> >> > >  user/support/support-project.rst |   2 +
> >> > >  5 files changed, 263 insertions(+), 1 deletion(-)
> >> > >  create mode 100644 user/start/faq.rst
> >> > >
> >> > > diff --git a/user/bld/index.rst b/user/bld/index.rst
> >> > > index ebedf5a..a8a8a4f 100644
> >> > > --- a/user/bld/index.rst
> >> > > +++ b/user/bld/index.rst
> >> > > @@ -82,7 +82,7 @@ specifies paths to build specification items.  It
> is an advanced option and
> >> > >  there is normally no need to use it.  It may be used to customize
> the build at
> >> > >  the level of the build specification.  For more information see the
> >> > >  `Build System` chapter of the
> >> > > -`RTEMS Software Engineering <
> https://docs.rtems.org/branches/master/eng/build-system.rst>`_
> >> > > +`RTEMS Software Engineering <
> https://docs.rtems.org/branches/master/eng/build-system.html>`_
> >> > >  guide.
> >> > >
> >> > >  Help
> >> > > @@ -283,6 +283,8 @@ example configuration file, building of the
> tests is enabled for the
> >> > >  [sparc/erc32]
> >> > >
> >> > >  [riscv/griscv]
> >> > > +
> >> > > +.. _Autoconf_migration:
> >> > this looks like something should be a cleanup separate submission.
> >> >
> >> > I think the tags are usually directly translated from the section
> >> > names with camelcase?
> >> > _Migration_from_AutoconfAutomake
> >> > or so? check other docs for consistency/guidance.
> >> >
> >> > >
> >> > >  Migration from Autoconf/Automake
> >> > >  
> >> > > diff --git a/user/overview/index.rst b/user/overview/index.rst
> >> > > index 550724a..0703ede 100644
> >> > > --- a/user/overview/index.rst
> >> > > +++ b/user/overview/index.rst
> >> > > @@ -20,6 +20,8 @@ You are someone looking for a real-time operating
> system.  This document
> >> > >
> >> > >  - helps you to build an example application on top of RTEMS.
> >> > >
> >> > > +.. _Features:
> >> > > +
> >> > >  Features
> >> > >  
> >> > >
> >> > > diff --git a/user/start/faq.rst b/user/start/faq.rst
> >> > > new file mode 100644
> >> > > index 000..da11ca4
> >> > > --- /dev/null
> >> > > +++ b/user/start/faq.rst
> >> > > @@ -0,0 +1,255 @@
> >> > > +Frequently Asked Questions
> >> > > +==
> >> > > +
> >> > > +What is RTEMS ?
> >> > > +---
> >> > > +
> >> > > +RTEMS is an open source real-time executive which provides a high
> performance
> >> > > +environment for embedded real-time applications including many
> features.
> >> > > +
> >> > > +The RTEMS Project is the umbrella term used to describe the
> collection of
> >> > > +individuals, companies, universities, and research institutions
> that collectively
> >> > > +maintain and enhance the RTEMS software base.
> >> > > +
> >> > > +RTEMS is designed to support applications with the most stringent
> 

Re: [PATCH 1/2] Added FAQ page

[Ayushman Mishra]

Sir, It was given as an issue https://devel.rtems.org/ticket/3958 (
Review wiki/TBR/Website/FAQ for correct links) for the faq page
https://devel.rtems.org/wiki/TBR/Website/FAQ

On Sat, Apr 3, 2021 at 12:10 AM Joel Sherrill  wrote:
>
>
>
> On Fri, Apr 2, 2021 at 1:19 PM Ayushman Mishra  
> wrote:
>>
>> Greetings Sir,
>> I have corrected and send patches regarding FAQ page in user manual.I
>> was able to build the page on my system and also attached a
>> screen-shot of the builded page on browser . I have corrected
>> whitespace consistency and reference links according to other
>> doc-pages
>
>
> Random question. Is this information from the Wiki or just an update
> of what was already in rtems-docs? If this obsoletes any information
> in the wiki, I would like to know so we can remove it.
>
>>
>> . Regarding the issue of cross-link between docs , I had
>> sent mail on devel mail list
>> https://lists.rtems.org/pipermail/devel/2021-March/065882.html but
>> haven't got any response , so few days ago after a little discussion
>> on discord vijay sir said to post the patch and someone might point it
>> to a better way if it exists.
>
>
> I don't know if we know the answer to that with Sphinx. If "we" do, then
> I am not part of that "we".  Hopefully someone will educate us. :)
>
> Gedare.. is the new patch OK? It must be in another thread because
> I don't see it here.
>
> --joel
>>
>>
>> On Wed, Mar 24, 2021 at 1:05 AM Gedare Bloom  wrote:
>> >
>> > Did you build the docs and verify they look good?
>> >
>> > On Tue, Mar 23, 2021 at 12:44 PM Ayushman Mishra
>> >  wrote:
>> > >
>> > > ---
>> > >  user/bld/index.rst   |   4 +-
>> > >  user/overview/index.rst  |   2 +
>> > >  user/start/faq.rst   | 255 +++
>> > >  user/start/index.rst |   1 +
>> > >  user/support/support-project.rst |   2 +
>> > >  5 files changed, 263 insertions(+), 1 deletion(-)
>> > >  create mode 100644 user/start/faq.rst
>> > >
>> > > diff --git a/user/bld/index.rst b/user/bld/index.rst
>> > > index ebedf5a..a8a8a4f 100644
>> > > --- a/user/bld/index.rst
>> > > +++ b/user/bld/index.rst
>> > > @@ -82,7 +82,7 @@ specifies paths to build specification items.  It is 
>> > > an advanced option and
>> > >  there is normally no need to use it.  It may be used to customize the 
>> > > build at
>> > >  the level of the build specification.  For more information see the
>> > >  `Build System` chapter of the
>> > > -`RTEMS Software Engineering 
>> > > `_
>> > > +`RTEMS Software Engineering 
>> > > `_
>> > >  guide.
>> > >
>> > >  Help
>> > > @@ -283,6 +283,8 @@ example configuration file, building of the tests is 
>> > > enabled for the
>> > >  [sparc/erc32]
>> > >
>> > >  [riscv/griscv]
>> > > +
>> > > +.. _Autoconf_migration:
>> > this looks like something should be a cleanup separate submission.
>> >
>> > I think the tags are usually directly translated from the section
>> > names with camelcase?
>> > _Migration_from_AutoconfAutomake
>> > or so? check other docs for consistency/guidance.
>> >
>> > >
>> > >  Migration from Autoconf/Automake
>> > >  
>> > > diff --git a/user/overview/index.rst b/user/overview/index.rst
>> > > index 550724a..0703ede 100644
>> > > --- a/user/overview/index.rst
>> > > +++ b/user/overview/index.rst
>> > > @@ -20,6 +20,8 @@ You are someone looking for a real-time operating 
>> > > system.  This document
>> > >
>> > >  - helps you to build an example application on top of RTEMS.
>> > >
>> > > +.. _Features:
>> > > +
>> > >  Features
>> > >  
>> > >
>> > > diff --git a/user/start/faq.rst b/user/start/faq.rst
>> > > new file mode 100644
>> > > index 000..da11ca4
>> > > --- /dev/null
>> > > +++ b/user/start/faq.rst
>> > > @@ -0,0 +1,255 @@
>> > > +Frequently Asked Questions
>> > > +==
>> > > +
>> > > +What is RTEMS ?
>> > > +---
>> > > +
>> > > +RTEMS is an open source real-time executive which provides a high 
>> > > performance
>> > > +environment for embedded real-time applications including many features.
>> > > +
>> > > +The RTEMS Project is the umbrella term used to describe the collection 
>> > > of
>> > > +individuals, companies, universities, and research institutions that 
>> > > collectively
>> > > +maintain and enhance the RTEMS software base.
>> > > +
>> > > +RTEMS is designed to support applications with the most stringent 
>> > > real-time
>> > > +requirements while being compatible with open standards such as POSIX.
>> > > +RTEMS includes optional functional features such as TCP/IP and various 
>> > > file
>> > > +systems while still offering minimum executable sizes under 20 KB in 
>> > > useful
>> > > +configurations.
>> > > +
>> > > +:ref:`More Features`
>> > > +
>> > > +Where can I get RTEMS ?
>> > > 

Re: [PATCH 1/2] Added FAQ page

[Joel Sherrill]

On Fri, Apr 2, 2021 at 1:19 PM Ayushman Mishra 
wrote:

> Greetings Sir,
> I have corrected and send patches regarding FAQ page in user manual.I
> was able to build the page on my system and also attached a
> screen-shot of the builded page on browser . I have corrected
> whitespace consistency and reference links according to other
> doc-pages


Random question. Is this information from the Wiki or just an update
of what was already in rtems-docs? If this obsoletes any information
in the wiki, I would like to know so we can remove it.


> . Regarding the issue of cross-link between docs , I had
> sent mail on devel mail list
> https://lists.rtems.org/pipermail/devel/2021-March/065882.html but
> haven't got any response , so few days ago after a little discussion
> on discord vijay sir said to post the patch and someone might point it
> to a better way if it exists.
>

I don't know if we know the answer to that with Sphinx. If "we" do, then
I am not part of that "we".  Hopefully someone will educate us. :)

Gedare.. is the new patch OK? It must be in another thread because
I don't see it here.

--joel

>
> On Wed, Mar 24, 2021 at 1:05 AM Gedare Bloom  wrote:
> >
> > Did you build the docs and verify they look good?
> >
> > On Tue, Mar 23, 2021 at 12:44 PM Ayushman Mishra
> >  wrote:
> > >
> > > ---
> > >  user/bld/index.rst   |   4 +-
> > >  user/overview/index.rst  |   2 +
> > >  user/start/faq.rst   | 255 +++
> > >  user/start/index.rst |   1 +
> > >  user/support/support-project.rst |   2 +
> > >  5 files changed, 263 insertions(+), 1 deletion(-)
> > >  create mode 100644 user/start/faq.rst
> > >
> > > diff --git a/user/bld/index.rst b/user/bld/index.rst
> > > index ebedf5a..a8a8a4f 100644
> > > --- a/user/bld/index.rst
> > > +++ b/user/bld/index.rst
> > > @@ -82,7 +82,7 @@ specifies paths to build specification items.  It is
> an advanced option and
> > >  there is normally no need to use it.  It may be used to customize the
> build at
> > >  the level of the build specification.  For more information see the
> > >  `Build System` chapter of the
> > > -`RTEMS Software Engineering <
> https://docs.rtems.org/branches/master/eng/build-system.rst>`_
> > > +`RTEMS Software Engineering <
> https://docs.rtems.org/branches/master/eng/build-system.html>`_
> > >  guide.
> > >
> > >  Help
> > > @@ -283,6 +283,8 @@ example configuration file, building of the tests
> is enabled for the
> > >  [sparc/erc32]
> > >
> > >  [riscv/griscv]
> > > +
> > > +.. _Autoconf_migration:
> > this looks like something should be a cleanup separate submission.
> >
> > I think the tags are usually directly translated from the section
> > names with camelcase?
> > _Migration_from_AutoconfAutomake
> > or so? check other docs for consistency/guidance.
> >
> > >
> > >  Migration from Autoconf/Automake
> > >  
> > > diff --git a/user/overview/index.rst b/user/overview/index.rst
> > > index 550724a..0703ede 100644
> > > --- a/user/overview/index.rst
> > > +++ b/user/overview/index.rst
> > > @@ -20,6 +20,8 @@ You are someone looking for a real-time operating
> system.  This document
> > >
> > >  - helps you to build an example application on top of RTEMS.
> > >
> > > +.. _Features:
> > > +
> > >  Features
> > >  
> > >
> > > diff --git a/user/start/faq.rst b/user/start/faq.rst
> > > new file mode 100644
> > > index 000..da11ca4
> > > --- /dev/null
> > > +++ b/user/start/faq.rst
> > > @@ -0,0 +1,255 @@
> > > +Frequently Asked Questions
> > > +==
> > > +
> > > +What is RTEMS ?
> > > +---
> > > +
> > > +RTEMS is an open source real-time executive which provides a high
> performance
> > > +environment for embedded real-time applications including many
> features.
> > > +
> > > +The RTEMS Project is the umbrella term used to describe the
> collection of
> > > +individuals, companies, universities, and research institutions that
> collectively
> > > +maintain and enhance the RTEMS software base.
> > > +
> > > +RTEMS is designed to support applications with the most stringent
> real-time
> > > +requirements while being compatible with open standards such as POSIX.
> > > +RTEMS includes optional functional features such as TCP/IP and
> various file
> > > +systems while still offering minimum executable sizes under 20 KB in
> useful
> > > +configurations.
> > > +
> > > +:ref:`More Features`
> > > +
> > > +Where can I get RTEMS ?
> > > +-
> > > +
> > > +:ref:`Downloading RTEMS`
> > > +
> > > +
> > > +What does RTEMS stand for ?
> > > +-
> > > +
> > > +RTEMS is an an acronym for the Real-Time Executive for Multiprocessor
> Systems.
> > an an
> >
> > > +
> > > +Initially RTEMS stood for the Real-Time Executive for Missile Systems
> but as it
> > > +became clear that 

Re: [PATCH 1/2] Added FAQ page

[Gedare Bloom]

Did you build the docs and verify they look good?

On Tue, Mar 23, 2021 at 12:44 PM Ayushman Mishra
 wrote:
>
> ---
>  user/bld/index.rst   |   4 +-
>  user/overview/index.rst  |   2 +
>  user/start/faq.rst   | 255 +++
>  user/start/index.rst |   1 +
>  user/support/support-project.rst |   2 +
>  5 files changed, 263 insertions(+), 1 deletion(-)
>  create mode 100644 user/start/faq.rst
>
> diff --git a/user/bld/index.rst b/user/bld/index.rst
> index ebedf5a..a8a8a4f 100644
> --- a/user/bld/index.rst
> +++ b/user/bld/index.rst
> @@ -82,7 +82,7 @@ specifies paths to build specification items.  It is an 
> advanced option and
>  there is normally no need to use it.  It may be used to customize the build 
> at
>  the level of the build specification.  For more information see the
>  `Build System` chapter of the
> -`RTEMS Software Engineering 
> `_
> +`RTEMS Software Engineering 
> `_
>  guide.
>
>  Help
> @@ -283,6 +283,8 @@ example configuration file, building of the tests is 
> enabled for the
>  [sparc/erc32]
>
>  [riscv/griscv]
> +
> +.. _Autoconf_migration:
this looks like something should be a cleanup separate submission.

I think the tags are usually directly translated from the section
names with camelcase?
_Migration_from_AutoconfAutomake
or so? check other docs for consistency/guidance.

>
>  Migration from Autoconf/Automake
>  
> diff --git a/user/overview/index.rst b/user/overview/index.rst
> index 550724a..0703ede 100644
> --- a/user/overview/index.rst
> +++ b/user/overview/index.rst
> @@ -20,6 +20,8 @@ You are someone looking for a real-time operating system.  
> This document
>
>  - helps you to build an example application on top of RTEMS.
>
> +.. _Features:
> +
>  Features
>  
>
> diff --git a/user/start/faq.rst b/user/start/faq.rst
> new file mode 100644
> index 000..da11ca4
> --- /dev/null
> +++ b/user/start/faq.rst
> @@ -0,0 +1,255 @@
> +Frequently Asked Questions
> +==
> +
> +What is RTEMS ?
> +---
> +
> +RTEMS is an open source real-time executive which provides a high performance
> +environment for embedded real-time applications including many features.
> +
> +The RTEMS Project is the umbrella term used to describe the collection of
> +individuals, companies, universities, and research institutions that 
> collectively
> +maintain and enhance the RTEMS software base.
> +
> +RTEMS is designed to support applications with the most stringent real-time
> +requirements while being compatible with open standards such as POSIX.
> +RTEMS includes optional functional features such as TCP/IP and various file
> +systems while still offering minimum executable sizes under 20 KB in useful
> +configurations.
> +
> +:ref:`More Features`
> +
> +Where can I get RTEMS ?
> +-
> +
> +:ref:`Downloading RTEMS`
> +
> +
> +What does RTEMS stand for ?
> +-
> +
> +RTEMS is an an acronym for the Real-Time Executive for Multiprocessor 
> Systems.
an an

> +
> +Initially RTEMS stood for the Real-Time Executive for Missile Systems but as 
> it
> +became clear that the application domains that could use RTEMS extended far
> +beyond missiles, the "M" changed to mean Military. When maintenance of RTEMS
> +transferred to OAR, the "M" was changed again to Multiprocessor.
> +
> +At one point, there were both Ada and C implementations of RTEMS.
> +Version 3.2.1 was the last RTEMS version to have implementations in both
> +languages. Supporting the Classic API Ada implementation was painful and 
> fraught
> +with compiler specific pitfalls. With version 3.5.x, the POSIX API was added 
> as
> +the means to support the GNU Ada Translator (GNAT). This effectively 
> eliminated
> +the need for an implementation in Ada as the C implementation could 
> effectively
> +support both languages.
> +
> +
> +Are there restrictions on the RTEMS License ?
> +
> +
> +RTEMS is licensed under a modified version of the GNU General Public License 
> (GPL).
> +The modification places no restrictions on the applications which use RTEMS 
> but
> +protects the interests of those who work on RTEMS.
> +
This needs to be updated at least to mention 2-clause BSD.

RTEMS is licensed under a combination of permissive licenses and
a modified version of the GNU General Public License (GPL).

> +`License in RTEMS
> + +license-requirements.html>`__
> +
> +
I think just 1 blank space?

> +What standards are supported by RTEMS?
> +-
> +
> +The original "Classic" RTEMS API is based on the Real-Time Executive