zephyriot / zephyr-issues

0 stars 0 forks source link

Missing board documentation for nios2/qemu_nois2 #1763

Open nashif opened 7 years ago

nashif commented 7 years ago

Reported by David Kinder:

Board documentation is expected for all supported boards found in the /boards folders

(Imported from Jira ZEP-1915)

nashif commented 7 years ago

by David Kinder:

Wiki page exists for this board and should be reviewed and moved to the board/ site.

nashif commented 7 years ago

by Andrew Boie:

What am I supposed to do here? This is not a real board, its an emulated target already documented in 'make help'. It works like any other QEMU target

nashif commented 7 years ago

by David Kinder:

If I go into boards/nios2/qemu_nios2 and do a "make help" it give an error saying there's no rule to make target 'help'. Where should I find the emulated target documentation you mention? (If I do a "make help" from the zephyr install dir, I just get a list of board targets but no information about them.) Each "supported board" is supposed to have documentation about it.

nashif commented 7 years ago

by Andrew Boie:

Every single QEMU target for every single arch works exactly the same from the end user perspective. Make help describes "make debugserver" and "make run" which are really the only way to interact with them.

If you want a general document on how to work with QEMU targets, fine, scope the JIRA for that. It is a waste of time to maintain separate documents for every qemu_* board definition in the tree when they will all have exactly the same contents.

nashif commented 7 years ago

by David Kinder:

Well that makes sense not to duplicate content - but I do see documentation for other QEMU emulated boards: https://www.zephyrproject.org/doc/boards/x86/qemu_x86/doc/board.html and https://www.zephyrproject.org/doc/boards/arm/qemu_cortex_m3/doc/board.html