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.

Sign up for GitHub

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

Jump to bottom

[Backport 2.28] check_files.py: Allow specific Box Drawings characters to be used #6983

Merged
merged 3 commits into from
Feb 3, 2023
Merged

[Backport 2.28] check_files.py: Allow specific Box Drawings characters to be used #6983

merged 3 commits into from
Feb 3, 2023

Conversation

aditya-deshpande-arm
Copy link
Contributor

Description

Currently, check_files.py enforces that Mbed TLS uses only valid UTF-8 and only other explicitly allowed characters. This PR adds three characters from the Box Drawings range to the list of allowed characters:

  • u\2500: “─”
  • u\2514: “└”
  • u\251C: “├”

These characters are used to construct file trees in Markdown, like the one below. These can serve as useful visual aids.

├── src
│   ├── dir1
│   │   ├── file1.c
│   ├── file2.c
│   ├── file3.c
│   ├── file4.c
├── include
│   ├── head1.h
│   ├── head2.h
│   ├── head3.h
├── Makefile
└── .gitignore

This PR also changes the wording of how the allowed characters are explained using inclusive terminology.

Gatekeeper checklist

@aditya-deshpande-arm
Allow specific Box Drawing UTF characters that are used in Markdown t…
ed514d3 
…rees in check_files.py

Signed-off-by: Aditya Deshpande <aditya.deshpande@arm.com>
@aditya-deshpande-arm
Modify comments to make them more inclusive
e76dc39 
Signed-off-by: Aditya Deshpande <aditya.deshpande@arm.com>
@aditya-deshpande-arm aditya-deshpande-arm added needs-review Every commit must be reviewed by at least two team members, needs-ci Needs to pass CI tests needs-reviewer This PR needs someone to pick it up for review component-test Test framework and CI scripts labels Jan 30, 2023
@aditya-deshpande-arm aditya-deshpande-arm mentioned this pull request Jan 30, 2023
Merged
3 tasks
@tom-cosgrove-arm tom-cosgrove-arm mentioned this pull request Jan 31, 2023
Merged
3 tasks
@aditya-deshpande-arm
Allow whole Box Drawings range
a9186f3 
Signed-off-by: Aditya Deshpande <aditya.deshpande@arm.com>
@davidhorstmann-arm davidhorstmann-arm removed the needs-reviewer This PR needs someone to pick it up for review label Feb 1, 2023
@gilles-peskine-arm gilles-peskine-arm added approved Design and code approved - may be waiting for CI or backports single-reviewer This PR qualifies for having only one reviewer and removed needs-review Every commit must be reviewed by at least two team members, labels Feb 1, 2023
@tom-cosgrove-arm
Copy link
Contributor

Clean CI - removing needs-ci

@tom-cosgrove-arm tom-cosgrove-arm removed the needs-ci Needs to pass CI tests label Feb 2, 2023
@gilles-peskine-arm gilles-peskine-arm merged commit a4f9148 into Mbed-TLS:mbedtls-2.28 Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gilles-peskine-arm gilles-peskine-arm gilles-peskine-arm approved these changes

@davidhorstmann-arm davidhorstmann-arm Awaiting requested review from davidhorstmann-arm

Assignees
No one assigned
Labels
approved Design and code approved - may be waiting for CI or backports component-test Test framework and CI scripts single-reviewer This PR qualifies for having only one reviewer
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@aditya-deshpande-arm @tom-cosgrove-arm @gilles-peskine-arm @davidhorstmann-arm