Skip to content

Normalize terminology to fit other standards #23

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

Conversation

PLeVasseur
Copy link
Collaborator

Based on some suggestions in #19, I've tried to align to other existing standards' categories for various things

Added

  • Decidability
  • Scope
  • Category

Also

  • Renamed fls.lock to spec.lock to make this update a little easier later when we migrate from FLS to the upstreamed version.
  • Added a flag when calling ./make.py to allow us to update the spec.lock after resolving the breaking checksums

@adfernandes
Copy link

The "compliant/non-compliant" terminology really helps get rid of some of the "emotional overtones" of the guidelines.

And I really like the "decidability" term!

Looks great - thank you!

Copy link

@AlexCeleste AlexCeleste left a comment

Choose a reason for hiding this comment

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

+1 for the language change!

(no review of the code change)

@PLeVasseur
Copy link
Collaborator Author

Thanks for the feedback @adfernandes!

I'm likely going to go ahead and merge this over the weekend barring any concerns from folks. That'll allow me to freshen up #16 to line up with these changes.

@PLeVasseur
Copy link
Collaborator Author

Ah and thank you @AlexCeleste! 🤝

@PLeVasseur
Copy link
Collaborator Author

PLeVasseur commented Mar 29, 2025

Also good news -- the nightly build works + properly breaks on upstream changes in FLS ☺️

Traceback
=========

    Traceback (most recent call last):
      File "/home/runner/work/safety-critical-rust-coding-guidelines/safety-critical-rust-coding-guidelines/.venv/lib/python3.12/site-packages/sphinx/cmd/build.py", line 432, in build_main
        app.build(args.force_all, args.filenames)
      File "/home/runner/work/safety-critical-rust-coding-guidelines/safety-critical-rust-coding-guidelines/.venv/lib/python3.12/site-packages/sphinx/application.py", line 426, in build
        self.builder.build_update()
      File "/home/runner/work/safety-critical-rust-coding-guidelines/safety-critical-rust-coding-guidelines/.venv/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 375, in build_update
        self.build(
      File "/home/runner/work/safety-critical-rust-coding-guidelines/safety-critical-rust-coding-guidelines/.venv/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 427, in build
        self.env.check_consistency()
      File "/home/runner/work/safety-critical-rust-coding-guidelines/safety-critical-rust-coding-guidelines/.venv/lib/python3.12/site-packages/sphinx/environment/__init__.py", line 825, in check_consistency
        self.events.emit('env-check-consistency', self)
      File "/home/runner/work/safety-critical-rust-coding-guidelines/safety-critical-rust-coding-guidelines/.venv/lib/python3.12/site-packages/sphinx/events.py", line 404, in emit
        results.append(listener.handler(self.app, *args))
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      File "/home/runner/work/safety-critical-rust-coding-guidelines/safety-critical-rust-coding-guidelines/exts/coding_guidelines/fls_checks.py", line 41, in check_fls
        raise FLSValidationError(error_message)
    coding_guidelines.fls_checks.FLSValidationError: The FLS specification has changed since the lock file was created:
      - New FLS ID added: fls_pkfgas34msas (B.736:1)
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_0LACQVmZpDQF: B.767:1 -> B.768:1
      Affected guidelines:
        No guidelines affected
      - Content changed for FLS ID fls_1tftbd91yfpd (20.3:9): checksum was f9383478... now a5ebe407...
      Affected guidelines:
        No guidelines affected
      - Content changed for FLS ID fls_29y59x8bmw75 (15.8.1:16): checksum was 44d7f93b... now 0baddc91...
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_2ht13dgtxi1o: B.736:1 -> B.737:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_30asi010yf1a: B.740:1 -> B.741:1
      Affected guidelines:
        No guidelines affected
      - Content changed for FLS ID fls_338rmbazl67o (20.3:4): checksum was 180d5806... now 7b9182c0...
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_34h60ubicgsj: B.739:1 -> B.740:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_3ebC3l839ajF: B.752:1 -> B.753:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_4hiznltf5wlu: B.765:1 -> B.766:1
      Affected guidelines:
        No guidelines affected
      - Content changed for FLS ID fls_5dlnffim6fso (14.7:30): checksum was 0e8c1af4... now 74a4e048...
      Affected guidelines:
        No guidelines affected
      - Content changed for FLS ID fls_6Z05BK2JSzpP (10:10): checksum was cd830a79... now 85d03d9e...
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_742ycx5181n: B.743:1 -> B.744:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_7htwpbmyq83u: B.771:2 -> B.772:2
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_7wp6y0xeqqve: B.747:1 -> B.748:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_84gqz3vwi5mj: B.774:1 -> B.775:1
      Affected guidelines:
        No guidelines affected
      - Content changed for FLS ID fls_8qxwwf4trnl (20.3:6): checksum was d1d17973... now 2f1f0566...
      Affected guidelines:
        No guidelines affected
      - Content changed for FLS ID fls_8z1sgtvchhhw (20.3:7): checksum was f0c4063f... now c0738db6...
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_9ab12k4vwsio: B.757:1 -> B.758:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_Jk7V1SOKE4Gm: B.767:2 -> B.768:2
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_M9NpzBH8Wf4z: B.746:1 -> B.747:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_MQiPWNwdk95I: B.763:1 -> B.764:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_NGGZEbmoLRbD: B.755:1 -> B.756:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_OLVD0u9w68Gl: B.764:1 -> B.765:1
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_Z8qvOkP4Zfj5: B.749:2 -> B.750:2
      Affected guidelines:
        No guidelines affected
      - Section changed for FLS ID fls_cl4fakfkpscp: B.756:2 -> B.757:2
      Affected guidelines:
        No guidelines affected

... snip ...
    
    Please manually inspect FLS spec items whose checksums have changed as corresponding guidelines may need to account for these changes.

Could use an improvement to only break the build if there's a guideline effected though! Maybe? Hmm, not so sure on second thought. Maybe better to always require human intervention?

@PLeVasseur PLeVasseur merged commit fc179e3 into rustfoundation:main Mar 29, 2025
1 check passed
@PLeVasseur PLeVasseur deleted the feature/normalize-with-existing-standard branch March 29, 2025 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants