platformio / platformio/platformio-docs

Document method for specifying data_dir for each build environmet

Open
#374 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
285
Forks
357
PR merge metrics
No merged PRs in 30d

Description

It is useful to have a different data_dir per env
and the feature as requested
platformio-core#4126
for override at env level has not been implemented.

That feature request did however contain WISDOM for how to specify different data_dir per env

[platformio]
data_dir = ${PROJECT_DIR}/data-${PIOENV}

Would be helpful if the data_dir documentation could be updated to include this workaround.

As mentioned Different SPIFFS images for different build environments

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked data_dir documentation page and review how it currently explains the option. Document the [platformio] configuration example using ${PROJECT_DIR}/data-${PIOENV} as a workaround for per-environment data directories, and confirm the page clearly explains when to use it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.