D6604: add a metainfo.yaml to make ECM a proper framework

[Harald Sitter]

This revision was automatically updated to reflect the committed changes.
Closed by commit R240:5f6aa58b8067: add a metainfo.yaml to make ECM a proper 
framework (authored by sitter).

REPOSITORY
  R240 Extra CMake Modules

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D6604?vs=16626=16641

REVISION DETAIL
  https://phabricator.kde.org/D6604

AFFECTED FILES
  README.md
  metainfo.yaml

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system

D6604: add a metainfo.yaml to make ECM a proper framework

[David Faure]

dfaure accepted this revision.
This revision is now accepted and ready to land.

REPOSITORY
  R240 Extra CMake Modules

BRANCH
  master

REVISION DETAIL
  https://phabricator.kde.org/D6604

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system

D6604: add a metainfo.yaml to make ECM a proper framework

[Harald Sitter]

sitter updated this revision to Diff 16626.
sitter added a comment.


  add a readme
  
  I've tried for like 2 hours to wire this into the existing docs
  build and get away with one README. Alas, no luck.

REPOSITORY
  R240 Extra CMake Modules

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D6604?vs=16443=16626

BRANCH
  master

REVISION DETAIL
  https://phabricator.kde.org/D6604

AFFECTED FILES
  README.md
  metainfo.yaml

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system

D6604: add a metainfo.yaml to make ECM a proper framework

[Harald Sitter]

sitter added a comment.


  In https://phabricator.kde.org/D6604#124228, @ochurlaud wrote:
  
  > At the time I thought about merging it but we would have to re-document 
everything in doxygen , which would be completely different from what upstream 
cmake does.
  >
  > The ECM page is already linked from the left menu. Does it make sense to 
have it in frameworks? It's more a prerequisite for the framework no?
  >
  > Anyway, a link would work though being suboptimal.
  
  
  The metainfo.yaml is a prerequisite for frameworks I think, yeah. If we could 
add a property to the yaml `generateApiDox: false` to prevent doxification of 
ECM that would also work all be it more work I suppose.
  
  BUT
  In a way, I am thinking that for consistency's sake it is actually nicer if 
ECM is listed alongside the other frameworks on 
https://api.kde.org/frameworks/index.html even if it then only links to the 
cmake documentation. It is, at the very least, more discoverable this way.

REPOSITORY
  R240 Extra CMake Modules

REVISION DETAIL
  https://phabricator.kde.org/D6604

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system

D6604: add a metainfo.yaml to make ECM a proper framework

[Olivier Churlaud]

ochurlaud added a comment.


  At the time I thought about merging it but we would have to read document 
everything in doxygen , which would be completely different from what upstream 
cmake does.
  
  The ECM page is already linked from the left menu. Does it make sense to have 
it in frameworks? It's more a prerequisite for the framework no?
  
  Anyway, a link would work though being suboptimal.

REPOSITORY
  R240 Extra CMake Modules

REVISION DETAIL
  https://phabricator.kde.org/D6604

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system

D6604: add a metainfo.yaml to make ECM a proper framework

[David Faure]

dfaure added a comment.


  Please add a README.md too, with the same syntax as in the other frameworks.

REPOSITORY
  R240 Extra CMake Modules

REVISION DETAIL
  https://phabricator.kde.org/D6604

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system

D6604: add a metainfo.yaml to make ECM a proper framework

[Harald Sitter]

sitter added a comment.


  Good point on trying it locally.
  
  So, as one could expect this adds ECM as a product
  
  F3808791: Screenshot_20170711_120142.png 

  
  Unfortunately given we have no actual documentation (outside the cmake 
documentation) this leads to a fairly useless page
  
  F3808793: Screenshot_20170711_120148.png 

  
  Am I right in assuming that the way to fix this is to write a mainpage which 
links to https://api.kde.org/ecm/ for the actual cmake documentation?

REPOSITORY
  R240 Extra CMake Modules

REVISION DETAIL
  https://phabricator.kde.org/D6604

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system

D6604: add a metainfo.yaml to make ECM a proper framework

[Harald Sitter]

sitter added a comment.


  related to https://phabricator.kde.org/D6603
  
  @ochurlaud I hope this will not break api.kde, given ECM hasn't had a 
metainfo.yaml previously it seems to have some sort of special arrangement?

REPOSITORY
  R240 Extra CMake Modules

REVISION DETAIL
  https://phabricator.kde.org/D6604

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system

D6604: add a metainfo.yaml to make ECM a proper framework

[Harald Sitter]

sitter created this revision.
Restricted Application added projects: Frameworks, Build System.
Restricted Application added subscribers: Build System, Frameworks.

REPOSITORY
  R240 Extra CMake Modules

BRANCH
  master

REVISION DETAIL
  https://phabricator.kde.org/D6604

AFFECTED FILES
  metainfo.yaml

To: sitter, ochurlaud, dfaure, skelly
Cc: #frameworks, #build_system