#278 Some documentation enhancements
Merged 11 months ago by nphilipp. Opened 11 months ago by nphilipp.
fedora-infra/ nphilipp/rpmautospec main--enhance-docs  into  main

file modified
+28
@@ -11,6 +11,15 @@ 

  Known constraints

  -----------------

  

+ Package versions must be determinable from the spec file alone

+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+ 

+ Both the Koji plugin and ``fedpkg`` preprocess package spec files outside of

+ the target build root. If the version field of a package depends on macros

+ not defined in the spec file (directly or indirectly), this will likely result

+ in unexpected behavior if the macros in question differ between the environment

+ of the target and that where preprocessing happens.

+ 

  One consistent release across the package

  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  
@@ -57,3 +66,22 @@ 

      git commit --allow-empty

  

  The resulting empty head commit can be pushed into the repository of the package and built normally.

+ 

+ 

+ Information about rpmautospec use in a built package

+ ----------------------------------------------------

+ 

+ When preprocessing spec files for building, `rpmautospec` adds a header to the

+ top of the spec file containing, among other things, information about its

+ version and which features are used, e.g.:

+ 

+ .. code-block::

+ 

+     ## START: Set by rpmautospec

+     ## (rpmautospec version 0.3.0)

+     ## RPMAUTOSPEC: autorelease, autochangelog

+     ...

+     ## END: Set by rpmautospec

+ 

+ The preprocessed spec file is available in the SRPM which is generated as part

+ of a package build.

no initial comment

rebased onto c4732bf

11 months ago

Pull-Request has been merged by nphilipp

11 months ago
Metadata