Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add buildtarget element #6

Closed
gaborbsd opened this issue Aug 14, 2014 · 7 comments
Closed

Add buildtarget element #6

gaborbsd opened this issue Aug 14, 2014 · 7 comments

Comments

@gaborbsd
Copy link

For make, Ant etc. build targets. Should be allowed inline and should allow replaceable inside. The latter is useful to describe a group of targets with a replaceable suffix that have a similar outcome.

@ndw ndw added the build label May 15, 2015
@ndw ndw added schema and removed build labels Sep 16, 2015
@kosek kosek added the v52 label Jun 22, 2016
@shudson310
Copy link
Contributor

Please provide an example of the intended usage. The TC would like to understand how this would work in different build environment contexts (ant, make, maven, travis, etc.). Should there be a more generic element, or other elements that might be needed to describe this?

@kosek kosek removed the v52 label Jan 18, 2017
@gaborbsd
Copy link
Author

 <step>
<para>The <buildtarget>extract</buildtarget> target is run.
  It looks for the port's distribution file (typically a
  <command>gzip</command>ped tarball) in
  <varname>DISTDIR</varname> and unpacks it into a temporary
  subdirectory specified by <varname>WRKDIR</varname>
  (defaults to <filename>work</filename>).</para>
  </step>

  <step>
<para>The <buildtarget>patch</buildtarget> target is run.
  First, any patches defined in <varname>PATCHFILES</varname>
  are applied.  Second, if any patch files named
  <filename>patch-<replaceable>*</replaceable></filename> are
  found in <varname>PATCHDIR</varname> (defaults to the
  <filename>files</filename> subdirectory), they are applied
  at this time in alphabetical order.</para>
  </step>

This is taken from FreeBSD Porters' Handbook (we use a customzied DB5 schema), you can see the whole XML here. And the rendered version.

@kosek
Copy link
Contributor

kosek commented Apr 25, 2018

This change is implemented in the new beta schema release available at:

https://docbook.org/xml/5.2b04/

Please test it and give us feedback.

@gaborbsd
Copy link
Author

Thank you for adding this element to the schema!

I believe that it should also be allowed inside userinput. It is quite common that we quote command lines when the build target is referred, e.g.:

<para>To build the software, run the <buildtarget>all</buildtarget> target:</para>
	
<screen><userinput><command>make</command> <buildtarget>all</buildtarget></userinput></screen>

@kosek
Copy link
Contributor

kosek commented Apr 26, 2018

So adding buildtarget to db.os.inlines pattern as well to existing db.programming.inlines should do the trick. Lets TC discuss this at their next meeting and eventually we can extended places where buildtarget is allowed in the next release.

@gaborbsd
Copy link
Author

Yes, I think so. At FreeBSD, we extensively refer to buildtarget in userinput so with the current implementation, we will still need schema customization for this. Do you mean the next beta or 5.3? It's such a small addition, it would be nice if it could fit into the final 5.2. :)

@kosek
Copy link
Contributor

kosek commented Apr 26, 2018

Of course I meant next beta release, V5.2b05, that should be released after next DocBook TC meeting with agreed changes.

@ndw ndw closed this as completed Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants