more documentation for README.md #157
Conversation
README.md
Outdated
|
|
||
| ### obscpio | ||
| The obscpio archive format is the new OBS specific archive format which used and generated by the [OBS Delta Store](http://openbuildservice.org/help/manuals/obs-reference-guide/cha.obs.architecture.html#delta_store) to store SCM changes in an incremental way. | ||
| It is used by the obs_scm service. A file <package>.obsinfo including useful information from your SCM system is generated, so you can access this data at buildtime. |
There was a problem hiding this comment.
It's not 100% clear to me from this wording whether obs_scm generates obscpio files or whether it consumes them. It seems to suggest that they are generated elsewhere (by the delta store) and "used by" (i.e. consumed) by obs_scm, but I think that would be a misinterpretation which contradicts the information on obs_scm below. Any chance you could tweak the wording to clarify this?
README.md
Outdated
| It is used by the obs_scm service. A file <package>.obsinfo including useful information from your SCM system is generated, so you can access this data at buildtime. | ||
|
|
||
| ### tar | ||
| The tar archive format is used to create a tarball and it is used by the services "tar" and "tar_scm" |
There was a problem hiding this comment.
Similar thing here - if a file format is "used by" X, that could mean either X is generating files in that format or X is consuming files in that format which were generated by something else.
* short description for each service * documenation about archive formats
|
@aspiers I hope the new version is a bit more clearer |
|
Another case of undocumented obsinfo leads to local builds with osc not working, because obsinfo is not copied by osc. Not sure if this belongs to this issue. Another case is that obs_scm services are also not working with osc because osc cannot handle the interface of this service, e.g. the pre build time source services setup. Dito for service type tar_scm. So it happens when you construct a service which needs to call a build time source service which needs for example obsinfo. |
|
@mmohring Not sure I follow entirely but please do submit follow-up issues (or even better, PRs)! Thanks! |
|
@mmohring Any chance you could submit a new issue for this? |
should fix #155 and #156