apache / apache/mynewt-documentation

Doc for sample project is out of sync with latest repo/tool versions

Open
#65 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Makefile
Stars
21
Forks
49
PR merge metrics
No merged PRs in 30d

Description

As of Jan.09.2019, when following the instructions from mynewt-documentation/docs/get_started/docker.rst and then mynewt-documentation/docs/get_started/project_create.rst , the version of the newt tool in the "latest" docker image will be 1.3.0 (cited as 1.1.0 in docker.rst)
"user@~/dockertest/myproj$ ../newt version
Apache Newt version: 1.1.0"

...and when following steps in project_create.rst, with the default project.yml file 'newt new myproj' creates, it will pull down version 1.5.0 of the project/core ...which when executing the command to run a test after the 'install', will yield this error:

"
newt test @apache-mynewt-core/sys/config

Error: This version of newt (1.3.0) is incompatible with your version of the apache-mynewt-core repo (1.5.0); Please upgrade your newt tool to version 1.5.0
"

Since this is a guide intended for the *inexperienced* Mynewt OS and newt tool user, it's *highly* problematic that it isn't completely error/mistake free

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare mynewt-documentation/docs/get_started/docker.rst and mynewt-documentation/docs/get_started/project_create.rst with the versions used by the latest Docker image and default project.yml. Re-run the documented newt version, newt new, install, and newt test steps to confirm the mismatch. Done means the guide's cited versions and commands work together without the reported compatibility error.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.