Skip to content

Improve Makefile portability and safety#98

Merged
leynos merged 2 commits intomainfrom
codex/fix-makefile-for-portable-sed-and-file-truncation
Jun 24, 2025
Merged

Improve Makefile portability and safety#98
leynos merged 2 commits intomainfrom
codex/fix-makefile-for-portable-sed-and-file-truncation

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 24, 2025

Summary

  • avoid truncating lib.rs.stub by using touch
  • insert DDlog headers using a single substitution for macOS sed support
  • convert leading spaces to tabs in Makefile

Testing

  • uvx mbake validate Makefile
  • make fmt
  • make markdownlint
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_685b1dce22108322b4b9cd6fdcf419c2

Summary by Sourcery

Improve Makefile portability and safety by adjusting sed in-place usage for macOS compatibility, using touch to prevent stub file truncation, consolidating header insertions into a single sed command, and standardizing indentation to tabs.

Enhancements:

  • Standardize Makefile indentation by converting spaces to tabs
  • Select sed in-place flags based on OS to support BSD/macOS and GNU sed
  • Use touch to safely create lib.rs.stub instead of redirecting to avoid truncation
  • Merge two sed insertions into a single command for DDlog header injection on macOS

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 24, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 39 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 1ec504c and 2d0e730.

📒 Files selected for processing (1)
  • Makefile (4 hunks)

Summary by CodeRabbit

  • Bug Fixes

    • Corrected file creation for stub files to prevent errors.
    • Improved the method for adding suppression attributes to generated Rust files, ensuring they are inserted more reliably.
  • Style

    • Fixed indentation inconsistencies for better readability.

Walkthrough

The Makefile was updated to correct indentation, improve code style consistency, and refine the process for creating and modifying Rust stub files. The method for inserting suppression attributes into generated Rust files was consolidated into a single sed command, and file creation now uses touch instead of erroneous redirection.

Changes

File(s) Change Summary
Makefile Fixed indentation, replaced redirection with touch for stub creation, and unified sed commands for inserting Rust suppression attributes.

Poem

In the warren where builds are made,
Indents now hop in tidy parade.
Sed’s magic wand, a single sweep,
Rust warnings lulled gently to sleep.
With touch, a stub is born anew—
A Makefile fresh as morning dew!
🐇✨

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/fix-makefile-for-portable-sed-and-file-truncation

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 24, 2025

Reviewer's Guide

This PR refactors the Makefile to enhance portability and safety by normalizing indentation to tabs, replacing stub truncation with a touch call, and consolidating sed header insertions into a single cross-platform command.

Flow diagram for improved Makefile DDlog header insertion

flowchart TD
    A[Find all .rs files in generated/lille_ddlog] --> B{Does file already have clippy::all header?}
    B -- Yes --> C[Do nothing]
    B -- No --> D[Insert both warnings and clippy::all headers in one sed command]
    D --> E[File is updated]
    C --> E
Loading

Flow diagram for safer lib.rs.stub creation in Makefile

flowchart TD
    A[After generating lib.rs] --> B[touch generated/lille_ddlog/lib.rs.stub]
    B --> C[lib.rs.stub exists and is not truncated]
Loading

File-Level Changes

Change Details Files
Normalize indentation and tabs throughout the Makefile
  • Convert leading spaces to tabs in the .PHONY target list
  • Indent SED_INPLACE assignments under Darwin and else branches
  • Adjust loop and recipe indentation for consistency
Makefile
Use touch instead of redirection to create stub file
  • Replace > generated/.../lib.rs.stub with touch generated/.../lib.rs.stub
Makefile
Combine sed invocations for macOS compatibility
  • Merge two separate sed insert commands into one substitution that injects both headers
  • Use single-quoted pattern with embedded newlines for BSD sed support
Makefile

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jun 24, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 24, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@leynos leynos merged commit 4f68bfe into main Jun 24, 2025
4 checks passed
@leynos leynos deleted the codex/fix-makefile-for-portable-sed-and-file-truncation branch June 24, 2025 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant