Skip to content

Conversation

@awvwgk
Copy link
Member

@awvwgk awvwgk commented Nov 8, 2020

This PR adds an extra section to the package manifest. It is excluded from checks in Fortran fpm.

The general idea behind this section is:

  • allow third party tools to store information in the package manifest
  • stage new entries for the fpm registry without requiring a change in the manifest reference

@awvwgk awvwgk added the specification Issue regarding fpm manifest and model label Nov 8, 2020
@milancurcic
Copy link
Member

allow third party tools to store information in the package manifest

I don't understand this. Can you give a concrete example? Why would other tools want to store info in the manifest? Would these be fpm plugins or something else?

@awvwgk
Copy link
Member Author

awvwgk commented Nov 9, 2020

I have nothing particular in mind yet, but one idea would be to allow tools like FORD/fprettify/... to read from fpm.toml instead of their own input file:

[extra.ford]
output_dir = "./docs"
docmark = "<"
predocmark = ">"
[extra.fprettify]
indent = 4

Managing those entries would be the responsibility of the respective tools and fpm just allows for a free space to do so.

The advantage of using fpm.toml is that the meta data has to specified only once, it reduces the repetition of project name, layout, descriptions, ... in case it is adapted by a commonly used tool.

@milancurcic
Copy link
Member

Got it. I'm not opposed to it, but also don't see the need until users ask for it.

If others like it, I don't mind it going forward. @everythingfunctional @LKedward @urbanjost @certik what do you think?

@everythingfunctional
Copy link
Member

Once you put it in, you have to support it. Without a specific use case or request for it, I'd be hesitant to put it in. It's an interesting idea, and would encourage tools and users to converge around supporting and using fpm, so I'm not opposed to it. I just don't think it should be done yet. We've got plenty of other things to get done first.

@LKedward
Copy link
Member

I am not opposed to this, I can see it's uses, particularly this:

The advantage of using fpm.toml is that the meta data has to specified only once, it reduces the repetition of project name, layout, descriptions, ... in case it is adapted by a commonly used tool.

which opens the way for others to develop more tooling for the Fortran ecosystem.

Once you put it in, you have to support it.

Regarding support, I think the point here is that the section is explicitly ignored by fpm, so there is no burden of maintenance for us.

@everythingfunctional
Copy link
Member

Regarding support, I think the point here is that the section is explicitly ignored by fpm, so there is no burden of maintenance for us.

True, there is essentially no maintenance cost for us, other than explicitly ignoring it and not being able to use that table for anything in the future. So it could be worth it, but as I said, I think we've got other things to worry about first.

@awvwgk awvwgk added the wontfix This will not be worked on label Dec 13, 2020
@awvwgk awvwgk closed this Dec 13, 2020
@awvwgk
Copy link
Member Author

awvwgk commented Dec 13, 2020

This has been stale for while, therefore closing it now, we can revisit this feature later in case there is need.

@awvwgk awvwgk deleted the extra-field branch August 4, 2021 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

specification Issue regarding fpm manifest and model wontfix This will not be worked on

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants