[csolution] files with category doc are not in the generated *.cbuild.yml

[tarek-bochkati]

Describe the bug
this might not be a bug, could be a wanted behavior ...
I have a cproject file:

• containing a README.md file with doc as category
• or referring to component with doc file

in the generated *.cbuild.yml, only source and header files are resolved.

To Reproduce

• add a README.md to *.cproject.yml file
• then convert to *.cbuild.yml
• check the generate *.cbuild.yml

Expected behavior

• the README.md should be in the generated *.cbuild.yml

Environment (please complete the following information):

• cmsis-toolbox
• Version: 2.1.0
• OS: windows

[brondani]

Indeed this is the intended behaviour. Documentation files are not relevant for the build which is the scope of *.cbuild.yml files.
Edit: This is the behaviour concerning files described in components, but not for user files. The mentioned README.md in *.cproject.yml appears also in *.cbuild.yml:

build:
  groups:
    - group: Documentation
      files:
        - file: ./README.md
          category: doc

[tarek-bochkati]

@brondani, do you think that is interesting to align both behaviors of user files and component files ?

IMHO:

• if we consider that the *.cbuild.yml is a build artifact only, then no need for doc files
• if we consider that the *.cbuild.yml is a lock file and it contains the resolved project state, then docs should be part of it (incl. component docs)

[jkrech]

We have moved on from the idea using *.cbuild.yml as a lock-file.
In #1122 -> introducing <csolution-name>.cbuild-pack.yml instead.

[brondani]

@tarek-bochkati Yes for consistency we should definitely align the behavior.
For completeness I would vote to print all files, leaving to consumers to filter the categories to their use cases, but this could inflate the *.cbuild.yml files with irrelevant data.

[tarek-bochkati]

@brondani I would vote also to have all files in the *.cbuild.yml
since I value the *.cbuild.yml as a resolved state of the project, and I hate to force other developers to do to resolve again the project just to extract files like the documents.

[LMESTM]

Hi @jkrech @brondani
for my information, have you come to a conclusion and a proposed way forward on this topic ?

[brondani]

@LMESTM I believe we agree all files must be listed in the *.cbuild.yml alongside their categories. I am scheduling this GH issue to be addressed for the next release.

Hint for the implementer: make use of RteTarget::GetFilteredFiles.