Support for samu -t compdb

Question

Support for samu -t compdb

ddevault opened this issue 5 years ago · comments

This is required for GNOME Builder to work. Alpine Linux has run into this problem during our migration from ninja to samurai, and we'll have to roll back the migration if it's not available.

compdb specification

ninja implementation

Ariadne Conill · Answer 1 · Thu Jan 23 2020 00:55:52 GMT+0800 (China Standard Time)

Are there any other tools that samurai is missing that ninja has?

Drew DeVault · Answer 2 · Thu Jan 23 2020 00:58:45 GMT+0800 (China Standard Time)

Yes. Not all of them are relevant, but some are:

[3:53:02] homura ~ $ ninja -t list
ninja subtools:
    browse  browse dependency graph in a web browser
     clean  clean built files
  commands  list all commands required to rebuild given targets
      deps  show dependencies stored in the deps log
     graph  output graphviz dot file for targets
     query  show inputs/outputs for a path
   targets  list targets by their rule or depth in the DAG
    compdb  dump JSON compilation database to stdout
 recompact  recompacts ninja-internal data structures

I would argue that commands, deps, graph, query, targets, and compdb are necessary to consider samurai a complete ninja replacement.

Drew DeVault · Answer 3 · Thu Jan 23 2020 01:06:04 GMT+0800 (China Standard Time)

We reckon that compdb and query would be sufficient for Alpine's purposes.

Ariadne Conill · Answer 4 · Thu Jan 23 2020 01:07:37 GMT+0800 (China Standard Time)

I suspect that compdb is all we need immediately, but query is likely needed as well. This change is breaking certain IDEs (GNOME Builder for example), and we will have to revert soon if there is not a fix.

Michael Forney · Answer 5 · Thu Jan 23 2020 04:41:17 GMT+0800 (China Standard Time)

Implemented now. Please test with GNOME Builder and let me know if it works as expected.

Ariadne Conill · Answer 6 · Thu Jan 23 2020 05:04:20 GMT+0800 (China Standard Time)

Based on some quick testing, it appears to be generating a valid compdb. Thanks!

Drew DeVault · Answer 7 · Thu Jan 23 2020 06:02:28 GMT+0800 (China Standard Time)

Thanks @michaelforney!

Natanael Copa · Answer 8 · Thu Jan 23 2020 20:36:46 GMT+0800 (China Standard Time)

This is awesome! Thanks for the quick fix!

Rasmus Thomsen · Answer 9 · Thu Jan 23 2020 22:55:04 GMT+0800 (China Standard Time)

Doesn't seem to work:

compile_commands.json is not a flatpak manifest, skipping: :6:67: Parse error: unexpected character ,', expected character ]'

Here's the file: https://gist.github.com/bcee62e546cbc6a9f1c912b48517e608

Produced with the latest gnome-software ( e668f6be33b23dfe311a23a93bbaebcfadfb8310 )

Rasmus Thomsen · Answer 10 · Fri Jan 24 2020 00:59:36 GMT+0800 (China Standard Time)

And here's the diff to ninja: https://gist.github.com/22967be0bc40b230ac2e24145ee5c15b

Michael Forney · Answer 11 · Fri Jan 24 2020 02:06:07 GMT+0800 (China Standard Time)

As @Cogitri commented on the commit, the issue is the trailing comma. This is now fixed in fe1b3ce.

The rest of the diff is not concerning. It just has a different ordering than ninja's output.

Eli Schwartz · Answer 12 · Mon Mar 30 2020 08:48:17 GMT+0800 (China Standard Time)

I was trying to figure out at first why I got a compilation database printed out when running ninja -t compdb, but the new release of samurai just printed out

[
]

Turns out if you use it via e.g. meson it will run samu -t compdb c_COMPILER_FOR_BUILD c_PCH_FOR_BUILD c_COMPILER c_PCH which works, but just samu -t compdb doesn't emulate the ninja behavior of printing everything (including e.g. CUSTOM_COMMAND rules).

Eli Schwartz · Answer 13 · Mon Mar 30 2020 08:51:28 GMT+0800 (China Standard Time)

Docs are inconsistent.

$ ninja -t compdb -h
usage: ninja -t compdb [options] [rules]

rules are optional here

$ samu -t compdb -h
usage: samu ... -t compdb [-x] rules...

rules are not optional, fair enough if this is a deliberate decision, but...

$ man samu
[...]
     samu [-C dir] [-f buildfile] -t compdb [-x] [rule...]
[...]

rules are optional again??? The manpage incorrectly states that samu will behave the way ninja does.

Michael Forney · Answer 14 · Mon Mar 30 2020 09:13:52 GMT+0800 (China Standard Time)

Looks like this behavior changed in ninja 1.10. samurai currently matches ninja 1.9 behavior.

The rules are optional; you get an empty compilation database, not an error. The usage message is fixed now.

rules are optional again??? The manpage incorrectly states that samu will behave the way ninja does.

The manual states that a compilation database is printed, not that specifying no rules means that all rules should be printed, so I'm not sure what you mean here.

Eli Schwartz · Answer 15 · Mon Mar 30 2020 09:27:23 GMT+0800 (China Standard Time)

Well, that's not optional, that is mandatory and passing the empty set as the set of rules to print. :p

Thanks for pointing out the ninja behavior, I was just looking at whatever archlinux currently provides.

I guess it is up to you to decide whether to implement this ninja 1.10 behavior. Since most users will probably be using it via a build system specifying the rules they want, it is probably okay as-is, albeit slightly surprising.
EDIT: to be clear, it is ninja 1.9 that is surprising here.

(And now, I will go release my 1.1 update to archlinux [community].)

Michael Forney · Answer 16 · Mon Mar 30 2020 09:38:20 GMT+0800 (China Standard Time)

I guess it is up to you to decide whether to implement this ninja 1.10 behavior. Since most users will probably be using it via a build system specifying the rules they want, it is probably okay as-is, albeit slightly surprising.

ninja worked this way for 7 years, so I don't think it is too surprising, especially since samurai only claims to implement ninja 1.9 behavior.

The ninja 1.10 behavior will be implemented with the rest of the features required (mainly dyndep), probably for the next release. If you want the behavior changed now, feel free to send a patch.