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

Small fatfs usability fixes #16800

Merged
merged 4 commits into from
Sep 2, 2021

Conversation

chrysn
Copy link
Member

@chrysn chrysn commented Sep 2, 2021

Contribution description

This is a collection of the small things that make life easier for someone who wants to give fatfs a try:

  • Name the tarball of tests/pkg_fatfs .tar.bz2 (tools like atool do look at extensions)
  • Make the extraction routine work even when bin/ has not yet been created (with Makefile style fixes as bycatch)
  • Tell user what to do when enabling fatfs to get a usable example (because the disk can't format itself)

Testing procedure

  • In tests/pkg_fatfs, run (there is not automation for this, is there?):

    $ make image all term
    > mount 0
    mounting file system image...
    [OK]
    Volume name: 
    0,124 GiB of 0,124 GiB available
    > ls
    //TEST.TXT
    
  • In examples/filesystem, follow the new set of instructions and observe that indeed the file system becomes usable with a TEST.TXT present from startup.

@chrysn chrysn added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation Area: pkg Area: External package ports Area: examples Area: Example Applications labels Sep 2, 2021
@github-actions github-actions bot added Area: tests Area: tests and testing framework and removed Area: pkg Area: External package ports labels Sep 2, 2021
@benpicco
Copy link
Contributor

benpicco commented Sep 2, 2021

We can also wire up format, the only issue is how to provide memory for the workbuffer #14430

@chrysn
Copy link
Member Author

chrysn commented Sep 2, 2021

Yeah, but that has dragged on long, and it's not like getting a ready-made file system with content rather than a blank one (or seeing that disk geometries matter here) is not helping the user.

(Does that PR need a review to get unstuck, or discussion, or changes?)

@benpicco
Copy link
Contributor

benpicco commented Sep 2, 2021

I think it needs consensus on where to get the 512 bytes memory needed while formatting:

  • dynamic allocation with malloc() and free()
  • static allocation
  • put it on the stack and hope for the best

@benpicco benpicco added the CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs label Sep 2, 2021
Copy link
Contributor

@benpicco benpicco left a comment

Choose a reason for hiding this comment

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

regardless, those doc improvements are still useful.

@chrysn chrysn added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Sep 2, 2021
@chrysn chrysn merged commit 2bf1202 into RIOT-OS:master Sep 2, 2021
@chrysn chrysn deleted the vfs-fat-usability branch September 2, 2021 18:54
@benpicco benpicco added this to the Release 2021.10 milestone Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation Area: examples Area: Example Applications Area: tests Area: tests and testing framework CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants