[PATCH 2/2] Adding strong and weak definitions

[Sebastian Huber]

On 10/06/2020 16:41, Richi Dubey wrote:

> Hi,
>
> Please mark the following required changes:
>
> 1) Add: cd rtems-qual/
> After git clone and before git submodule init.
>
> 2) I am getting the following error on running git submodule update:
>
> richi at YouAreAmazing:~/rtems-qual$ git submodule update
> Cloning into '/home/richi/rtems-qual/external/rsb'...
> Cloning into '/home/richi/rtems-qual/external/rtems'...
> Cloning into '/home/richi/rtems-qual/external/rtems-docs'...
> Submodule path 'external/rsb': checked out
> '9482a1b33b4c8552f6affa582664b4ac25f9cdf4'
> error: Server does not allow request for unadvertised object
> aaa638b1550e94b37df382474fe4785a6cc7d350
> Fetched in submodule path 'external/rtems', but it did not contain
> aaa638b1550e94b37df382474fe4785a6cc7d350. Direct fetching of that
> commit failed.
>
> I don't understand this error.

Sorry, I fixed this issue. Please do a:

git pull

git submodule init

git submodule update

make env

>
> 3) Is the space in ". env/bin/activate" intentional?

Yes:

https://unix.stackexchange.com/questions/114300/whats-the-meaning-of-a-dot-before-a-command-in-shell

>
> 4) I do not know how to use cite, Can i use it directly in the text field?
Yes, just use :cite:`XYZ` in the text field.
>
> 5) When I run ./spec2doc.py, I get the following error:
>
> (env) richi at YouAreAmazing:~/rtems-qual$ ./spec2doc.py
> Traceback (most recent call last):
>    File "./spec2doc.py", line 41, in <module>
>      main()
>    File "./spec2doc.py", line 34, in main
>      item_cache = rtemsqual.items.ItemCache(config["spec"])
>    File "/home/richi/rtems-qual/rtemsqual/items.py", line 331, in __init__
>      self._load_items(config)
>    File "/home/richi/rtems-qual/rtemsqual/items.py", line 403, in _load_items
>      self._load_items_recursive(path, path, cache_dir)
>    File "/home/richi/rtems-qual/rtemsqual/items.py", line 381, in
> _load_items_recursive
>      for name in os.listdir(path):
> FileNotFoundError: [Errno 2] No such file or directory: 'external/rtems/spec'
>
> Is it because I messed something up in the strongapa.yml ?
>
> My /spec/glossary/strongapa.yml is :
>
> SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
> copyrights:
> - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
> enabled-by: true
> glossary-type: term
> links:
> - role: glossary-member
>    uid: ../glossary-general
> term: Strong APA
> text:

Maybe start with:

Strong APA is a specialization of ${apa:/term}.

>    In this model, on the arrival of a task, every task reachable

task -> thread

For the first use of thread use: ${thread:/term}

>    from the newly arrived task is checked to see if an existing
>    task can be shifted(or deallocated its processor) and newly
space before (
>    arrived task can take its place if the newly arrived task has
>    a higher priority. Similar analysis is done when a task
>    finishes its execution (Here task and thread have interchangeable
>    defintions).
>    :cite:`Cerqueira:2014:LPA`.
> type: glossary
>
>
>
> Please tell me how to resolve this error.
>
> Thanks,
> Richi.
>
> On Mon, Jun 8, 2020 at 1:13 PM Sebastian Huber
> <sebastian.huber at embedded-brains.de> wrote:
>> On 07/06/2020 15:36, Sebastian Huber wrote:
>>
>>> On 06/06/2020 15:09, Richi Dubey wrote:
>>>
>>>> Hii,
>>>>
>>>> Thanks for your review.
>>>>
>>>>> The glossary is generated from specification items:
>>>>>
>>>>> https://git.rtems.org/sebh/rtems-qual.git/tree/spec/glos/term
>>>>>
>>>>> I will work on a documentation how this works in the next days.
>>>> Have you already submitted one? If yes, could you please send me the
>>>> link to it. If no, Do I need to wait and learn that before sending in
>>>> the new patch?
>>> Yes, I sent a patch for the RTEMS Software Engineering manual:
>>>
>>> https://lists.rtems.org/pipermail/devel/2020-June/060036.html
>>>
>>> I will probably check it in tomorrow.
>> I updated the documentation:
>>
>> https://docs.rtems.org/branches/master/eng/req/howto.html#getting-started
>>
>> Could you please try to add the new glossary terms using the method
>> described in this how-to. You are some sort of a beta tester for this.
>> If anything is unclear, then please complain immediately.
>>