Bugzilla – Full Text Bug Listing
| Summary: | Missing/unclear explanations in doc for PDE/Build | ||
|---|---|---|---|
| Product: | [Eclipse Project] PDE | Reporter: | Stephan Herrmann <stephan.herrmann> |
| Component: | Doc | Assignee: | PDE-Doc-Inbox <pde-doc-inbox> |
| Status: | CLOSED WORKSFORME | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | ||
| Version: | 3.6 | ||
| Target Milestone: | --- | ||
| Hardware: | PC | ||
| OS: | Linux | ||
| Whiteboard: | stalebug | ||
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. -- The automated Eclipse Genie. Closing as WORKSFORME because: (1) my build (for Object Teams) is working quite stably for many years ... (2) PDE/Build is no longer recommended for new projects (since quite some time). => ergo no need to spend time on improving documentation. |
I'm sorry this is too late for Helios, but since I recently "modernized" an old set of PDE build scripts I'll just report which information I could not easily find/interpret in the help and in template files. "Building p2 Repositories and Products" - this page mentions: "the final assemble and packaging scripts will mirror and/or install from this repository into the locations that will become the archives produced by the build." Missing explanations: - what are "the locations that will become ..."? How are these paths determined? - what exactly are the differences between the outputs from building, mirroring and installing? - given we can skip all this if skipMirroring and skipDirector are set, what exactly happens if only one of them is set? skipDirector is hardly documented at all. If these are cool features I'd like to learn *why* I should use them. "Reusing p2 Metadata" - the description about "Context repositories" made me think that I could use this for re-using my own meta data from previous builds, however, setting "p2.context.repos" did not prevent unchanged bundles to be re-created with new metadata. Apparently, I was barking up some wrong tree. regarding file /org.eclipse.pde.build/templates/headless-build/build.properties: - it is not clear, which of the properties in this file are mandatory. - the following properties are not really explained: skipBase, eclipseURL, eclipseBuildId, eclipseBaseURL how do these relate to "baseLocation"? From experiements I seem to remember that these properties are used to unpack an eclipse *after* everything had been built so the purpose is unclear to me. I was uncomfortable about this because some of the other template files seem to depend on these properties. - "pluginPath": for the distracted reader it would be helpful if the explanation repeats the purpose in this section: I assume these paths will be searched during compilation, right? With no explanation "locations in which to find plugins and features" could mean anything, could even make me think this is where I should specify the path to, e.g., the plugin containing the SVNFetchFactory. Given that early docs about p2 mention separate artifact repository and metadata repository (traces are still in the docs), it might be good if the use of the word "repository" would always be qualified in some way. Or a definition of this term could be inserted at a prominent place? Perhaps some of my lack of understanding could better be mended using, e.g., some howtos in the wiki. General questions that I feel insufficiently answered by the help and template files: - which option is for me? Why would I want to use this or that? - concise definition of terms like "repository", "mirroring" etc. Last question: where should one look for documentation on running JUnit tests from PDE/Build? To what degree do the mentioned tasks and options support this (like installing the build result into an eclipse from which tests will be run)? To be perfectly clear: I did manage to get our build running again after "modernizing" some ancient bits (some as old as Eclispe 3.0) to current technology. Yet, I feel that these tasks require quite some guesswork and trial and error - which isn't the most efficient way of working :)