Add docs: Why not PDB files? #2387
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Uilian Ries <[email protected]>
|
Updating docs! |
jgsogo
approved these changes
Aug 3, 2020
czoido
previously approved these changes
Aug 4, 2020
SSE4
previously approved these changes
Aug 4, 2020
|
@uilianries , please, fix the conflict. Thanks! |
|
@jgsogo Done! |
|
Updating docs! |
jgsogo
suggested changes
Aug 11, 2020
docs/faqs.md
Outdated
| @@ -63,7 +63,7 @@ Unless they are a general and extended utility in recipes (in which case, we sho | |||
|
|
|||
| ## What version should packages use for libraries without official releases? | |||
|
|
|||
| The notation shown below is used for publishing packages where the original library does not make official releases. Thus, we use a format which includes the datestamp corresponding to the date of a commit: `cci.<YEAR MONTH DAY>`. In order to create reproducible builds, we also "commit-lock" to the latest commit on that day. Otherwise, users would get inconsistent results over time when rebuilding the package. An example of this is the [RapidJSON](https://github.com/Tencent/rapidjson) library, where its package reference is `rapidjson/cci.20200410` and its sources are locked the latest commit on that date in [config.yml](https://github.com/conan-io/conan-center-index/blob/master/recipes/rapidjson/config.yml#L4). The prefix `cci.` is mandatory to distinguish as a virtual version provided by CCI. If you are interested to know about the origin, please, read [here](https://github.com/conan-io/conan-center-index/pull/1464). | |||
| The notation shown below is used for publishing packages where the original library does not make official releases. Thus, we use a datestamp corresponding to the date of a commit. In order to create reproducible builds, we also "commit-lock" to the latest commit on that day. Otherwise, users would get inconsistent results over time when rebuilding the package. An example of this is the [NanoRange](https://github.com/tcbrindle/NanoRange) library, where its package reference is `nanorange/20191001` and its sources are locked the latest commit on that date: https://github.com/conan-io/conan-center-index/blob/master/recipes/nanorange/all/conandata.yml#L2L3 | |||
There was a problem hiding this comment.
I think this PR shouldn't modify this FAQ.
There was a problem hiding this comment.
What?! Probably I mixed the branches! I gonna fix it, thanks
Signed-off-by: Uilian Ries <[email protected]>
|
Updating docs! |
|
@jgsogo Done! |
jgsogo
approved these changes
Aug 12, 2020
danimtb
approved these changes
Aug 12, 2020
danimtb
reviewed
Aug 12, 2020
|
|
||
| #### Why is there no option for PDB, as there is for fPIC? | ||
|
|
||
| Adding one more common option, it seems the most simple and obvious solution, but it contains a side effect already seen with fPIC. It is necessary to manage the entire recipe, it has become a Boilerplate. So, adding PDB would be one more point to be reviewed for each recipe. In addition, in the future new options could arise, such as sanity or benchmark, further inflating the recipes. For this reason, a new option will not be added. However, the inclusion of the PDB files is discussed in issue #1982 and there are some ideas for making this possible through a new feature. If you want to comment on the subject, please visit issue. |
There was a problem hiding this comment.
Issue #1982 here is formatted automatically by Github markdown? I am not sure...
There was a problem hiding this comment.
Neither do I, but my plan was to try it and submit a fix if needed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've added a better description for https://github.com/conan-io/conan-center-index/blob/master/docs/error_knowledge_base.md#kb-h017-pdb-files-not-allowed. Also, I included a small typo fix (thanks to the code editor).