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

Clean README and enhanced install instructions for protobuf in Docu #715

Merged
merged 3 commits into from
Jun 15, 2023

Conversation

PhRosenberger
Copy link
Contributor

@PhRosenberger PhRosenberger commented Feb 16, 2023

Reference to a related issue in the repository

Relates to

Add a description

We need better install instructions for static / dynamic linking, so this PR should enhance the README for this.
More explanation should then follow in the OSI documentation, I guess?

Take this checklist as orientation for yourself, if this PR is ready for the Change Control Board:

@jdsika
Copy link
Contributor

jdsika commented Feb 22, 2023

Use placeholder for version

@jdsika jdsika added the OpenMSL Required to enable sub-libraries in OpenMSL. label Mar 3, 2023
@PhRosenberger PhRosenberger changed the title README with enhanced install instructions for protobuf Clean README and enhanced install instructions for protobuf in Docu Mar 13, 2023
@PhRosenberger PhRosenberger linked an issue Mar 13, 2023 that may be closed by this pull request
@PhRosenberger PhRosenberger force-pushed the 592-problems-with-dynamic-linking branch 2 times, most recently from 6eb143b to 8d887f8 Compare March 13, 2023 10:18
@PhRosenberger
Copy link
Contributor Author

@pmai, could you please provide the further details on proper linker flags in addition to the instructions in the new file installing_prerequisites.adoc?

@PhRosenberger
Copy link
Contributor Author

@philipwindecker Thanks a lot for your support with documentation references and your review!

Copy link
Contributor

@philipwindecker philipwindecker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review done. I would recommend using description lists instead of bold formatting because they provide more consistent styling. See https://docs.asciidoctor.org/asciidoc/latest/lists/description/
https://docs.asciidoctor.org/asciidoc/latest/lists/horizontal/

Alternatively, using subsections (level 2 i.e. ===) would help with automatically creating anchors and entries in the toc.

@pmai pmai added the ReadyToMerge This PR has been approved to merge and will be merged by a member of the CCB. label May 22, 2023
@pmai
Copy link
Contributor

pmai commented May 22, 2023

CCB 2023-05-22: Merge as-is, conflicts to be resolved @pmai

@pmai pmai force-pushed the 592-problems-with-dynamic-linking branch from 9989c54 to 6cecadd Compare June 15, 2023 17:46
@pmai pmai force-pushed the 592-problems-with-dynamic-linking branch from 6cecadd to fefe981 Compare June 15, 2023 17:49
@pmai pmai dismissed philipwindecker’s stale review June 15, 2023 17:52

Changes have been performed as requested

@pmai pmai merged commit 4f63bb1 into master Jun 15, 2023
@pmai pmai deleted the 592-problems-with-dynamic-linking branch June 15, 2023 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Everything which impacts the quality of the documentation and guidelines. OpenMSL Required to enable sub-libraries in OpenMSL. ReadyToMerge This PR has been approved to merge and will be merged by a member of the CCB.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Windows installation guide link error 404 Problems with dynamic linking
4 participants