Add instructions for building a function ldeinit #537
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @khinsen, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request updates the build documentation in the README to include specific instructions for building the ldeinit binary. This is crucial information for users who need to perform custom loadups and construct sysout files, as the standard build process does not yield a functional ldeinit for this purpose.
Highlights
- Documentation Update: Added a new bullet point to the 'Building with make' section in
README.md. - Building
ldeinit: Provided specific instructions (./makeright init cleanfollowed by./makeright init) for building a functionalldeinitbinary, noting that the standard build process does not produce one suitable for constructing sysout files.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds instructions to the README.md for building the ldeinit binary using the makeright script. This is a useful addition for users who need to perform tasks like custom sysout creation.
The review includes one suggestion to rephrase the new instruction slightly to enhance clarity and prevent potential misunderstanding about how the ldeinit build process relates to the general build steps described earlier in the document.
No specific style guide was provided; the review feedback regarding the documentation aims for clarity and accuracy, adhering to general Markdown best practices.
README.md
Outdated
| @@ -37,6 +37,7 @@ $ ./makeright x | |||
|
|
|||
| * The build will (attempt to) detect the OS-type and cpu-type. It will build binaries `lde` and `ldex` in `../`_`ostype.cputype`_ (with .o files in `../`_`ostype.cputype-x`_. For example, Linux on a 64-bit x86 will use `linux.x86_64`, while macOS 11 on a (new M1) Mac will use `darwin.aarch64`. | |||
| * If you prefer `gcc` over `clang`, you will need to edit the makefile fragment for your configuration (`makefile-ostype.cputype-x`) and comment out the line (with a #) that defines `CC` as `clang` and uncomment the line (delete the #) for the line that defines `CC` as `gcc`. | |||
| * If you want to do your own loadups to construct sysout files (see [the Medley repository](https://github.com/Interlisp/medley) for details), you also need the `ldeinit` binary. However, the `ldeinit` you get from the above steps is *not* functional. You have to run `./makeright init clean` followed by `./makeright init` to get a correct `ldeinit` binary. | |||
There was a problem hiding this comment.
The phrasing "the ldeinit you get from the above steps is not functional" could be confusing, as the preceding steps (e.g., ./makeright x) are described as building lde or ldex, not ldeinit. This might lead users to incorrectly assume that an ldeinit binary is an expected output of those standard build commands.
To improve clarity, consider rephrasing to emphasize that ldeinit requires a distinct build process separate from the standard ones mentioned earlier. The suggested change below aims to make this distinction clearer.
| * If you want to do your own loadups to construct sysout files (see [the Medley repository](https://github.com/Interlisp/medley) for details), you also need the `ldeinit` binary. However, the `ldeinit` you get from the above steps is *not* functional. You have to run `./makeright init clean` followed by `./makeright init` to get a correct `ldeinit` binary. | |
| * If you need the `ldeinit` binary (e.g., for custom loadups to construct sysout files – see [the Medley repository](https://github.com/Interlisp/medley) for details), it requires a special build. The standard build commands (like `./makeright x`) do not produce a functional `ldeinit`. To build a correct `ldeinit` binary, run `./makeright init clean` and then `./makeright init`. |
No description provided.