27 Commits

Author SHA1 Message Date
Karakurt
580bc4f70d Updated flasher script with some quality of life (#2141)
* Added automatic retries

* Generalized naming
2025-07-17 00:10:50 +00:00
Ben V. Brown
260891b00b Adding documentation around debugging PD PSU's (#2111)
* Create USB-PD Debug docs

* Add to menu

* Update DebuggingPD.md
2025-07-07 14:49:48 +10:00
Philippe Teuwen
83aa1b6425 Adding Pinecilv2 ws2812b mod option (#2099)
* support for WS2812B mod on Pinecil v2

* document support for WS2812B mod on Pinecil v2

* update IronOS-mkdocs.yml

* Protect WS2812B_Pin with define WS2812B_ENABLE
2025-03-06 22:36:01 +03:00
Ben V. Brown
7eee1b74d7 Update alpine 2025-02-23 18:47:50 +11:00
Ivan Zorin
22d0676a5c scripts/deploy.sh: add handmade linter for translation-related json files to check for tabs and odd spaces (#2064)
* scripts/deploy.sh: add handmade linter for translation-related json files to check for tabs and odd spaces
2025-02-02 07:20:12 +11:00
Ivan Zorin
712c8f99da scripts/deploy.sh: add test for links to stable builds in README 2024-12-03 01:46:44 +03:00
Ivan Zorin
c607e73739 Langs check (#2006)
* source/Makefile: add temp change for demo

* scripts/deploy.sh: add test check for languages

* scripts/deploy.sh: shellcheck sanitization

* source/Makefile: revert changes for the demo
2024-11-25 20:00:59 +11:00
Ivan Zorin
26c50d7962 Check the presence of changelog for the latest stable release in History.md (#1999)
* Documentation/History.md: update version format according to git tag for easiest automation

* Add test check for changelog of the latest stable version

* Add git config permissions routine to test docs via push.yml

* scripts/deploy.sh fixes

* making shellcheck happy due to false negative in deploy.sh

* push.yml: fetch tags for test docs

* push.yml: set fetch depth trying to get tags

* deploy.sh printf debugging

* deploy.sh: remove printf debugging

* push.yml: rename step from check_readme to check_docs to reflect its function
2024-11-21 20:16:02 +11:00
MyNameIsKitsune
d0bcf40e5c Linux Flash script update for TS100 (#1997)
* Using dd instead cp and unmount tmp folder immediately

* add sudo to rmdir
2024-11-16 10:39:10 +00:00
Ben V. Brown
20bb895253 Update porting guide + cleanups (#1898)
* Update porting guide + cleanups

* Documentation/README.md: update autogenerated file
2024-04-03 14:00:44 +11:00
Ben V. Brown
ec5f07ec0c Cleanup make includes and formatting rules (#1860)
* Draft cleanup of the folder definition mess

* Move old startup

* Fixup! broken hacky includes

* Update Makefile

* Update Makefile

* Update Makefile

* Bulk format

* Who knew, header guards are a wise idea

* Squash some sizing warnings

* Drop broken usb stack

* Fix BLE headers to be sensible

* Cleaning up proper c styling

* We have newer clang, it does bracketing now

* Run clang-format brackets

* We can drop the old messy bracket-checker with newer clang format

* WiP formatter

* Align grids of scripts by right side

Massively easier to read in nearly all cases

* Excempt the table for compression from formatter
2023-12-27 09:23:12 +11:00
Ben V. Brown
849d1f7d40 Update compilers (#1858)
* Update Alpine Image

* Update push.yml

* Style updates
2023-12-26 19:54:47 +11:00
Ivan Zorin
5754622fea Include History.md to online docs as Changelog (#1799)
docs/changelog: include History.md to read-the-docs site generating as Changelog, update titles formatting & unify style between sections
2023-08-16 10:06:55 +10:00
Ivan Zorin
20e085487e Add python packages required by mkdocs into docker container (#1796)
Add PIP python packages required by mkdocs into docker container
2023-08-14 11:13:34 +10:00
Ivan Zorin
33439aaa22 Include Bluetooth document to read-the-docs site generating (#1798) 2023-08-14 11:11:54 +10:00
Ivan Zorin
130e73c1fe Make make docker-clean to remove docker build cache (#1790)
Makefile: add docker-clean sub-targets to remove not only image but cache (eats lot of space sometimes) & update help output / add clean-up of docker cache to deploy.sh as well

Co-authored-by: Ben V. Brown <5425387+Ralim@users.noreply.github.com>
2023-08-09 05:38:45 +00:00
Ivan Zorin
3f880d9e26 Implement ci target for Makefile to reproduce github CI actions & artifacts (#1769)
* Implement CI target in Makefile to emulate github CI actions & artifacts

* Improve filter for metadata

* metadata.py: update usage output for wrong number of input arguments / code review

* metadata.py: remove excessive checks for the second input argument / code review

* metadata.py: remove hard-coded model for multi-lang builds in ModelName argument processing / code review

* metadata.py: remove hard-coded models for multi-lang builds in file name pattern processing / code review

* metadata.py: update usage output to remove ambiguity about json extension for output file

* metadata.py: unify new lines style formatting

* metadata.py: sort the list of processing files in alphanumeric order before looping through them to get the same lang order on every generation in every json output file
2023-08-04 21:32:17 +10:00
Ivan Zorin
e0f373a88a Decomission of scripts/ci (#1760)
* Decomission of scripts/ci

* Code review

* Update .gitignore according to changes for code review
2023-07-31 10:06:57 +10:00
Ivan Zorin
f83ebc8c81 Implement target in Makefile to run github CI-like checks locally (#1753)
* Makefile: implement tests target with subtargets to run github CI-like tests locally (in docker container)

* Dockerfile: update comment for PIP packages
2023-07-23 22:18:45 +10:00
Ivan Zorin
52dd27cc07 Fix github CI clang-format related check_c-cpp job (#1752)
* Fix github CI clang-format related check_c-cpp job

* shellcheck fix
2023-07-21 14:47:16 +10:00
Ivan Zorin
1c9d3940ca Move related pieces of documentation from wiki to Documentation/ (#1746)
* Move TS100 info from wiki to Hardware.md

* Move TS80 info from wiki to Hardware.md

* Move TS80P info from wiki to Hardware.md

* Move Pinecil info from wiki to Hardware.md

* Move some info from Home.md wiki to Documentation/index.md

* Fix path inside docker since Dockerfile has been updated to be in the root project tree after starting container

* Move info from Home.md wiki to Documentation/Hardware.md

* mkdocs.yml: swtich config to forked repo for testing formatting online

* Fix formatting

* Fix formatting (md != rtd)

* Fix formatting for index.md

* Revert mkdocs config to original one after testing

* Documentation/: add power sources info

* Documentation/README.md: update with power sources

* tiny fixes with formatting

* Reformat links to stores

* Fix footnote on _default_ charger for TS80P

* Revert mkdocs config

* Fix footnote about wattage for QC, try fix table in index.md
2023-07-20 11:55:08 +10:00
Ivan Zorin
297a4dffa5 Replace /build/source by /build/ironos to eliminate ambiguity with /build/source/source (#1748)
* docker/buildAll.sh: replace /build/source by /build/ironos to eliminate ambiguity with /build/source/source

* scripts/ci/buildAll.sh: fix shellcheck and add additional comment
2023-07-20 11:52:22 +10:00
Ivan Zorin
93a18e5076 Move check-style core logic from makefile to shell script (#1745)
* Move check-style core logic from source/Makefile:check-style target to deploy.sh:check_style_file function

* deploy.sh: fix shellcheck warning

* source/Makefile: restore removed-by-accident style target
2023-07-20 11:02:56 +10:00
Ivan Zorin
d95af7d1a0 clang-format implementation (#1740)
* Testing clang-format style check using github CI

* github/push: implement check-style for clang-format as a separate build step

* github/push: add missing packages for check-style/clang-format build step

* source/Makefile: check-style - reduce files of interest; update .clang-format to keep enums init

* source/Makefile: empty lines, spaces & tabs refactoring to unify style - part 1 out of N

* source/Makefile: fix formatting for multi-line variables

* source/Makefile: update formatting for multi-line variables

* source/Makefile: remove spaces on vars assignments to unify style

* source/Makefile: remove unused target style

* source/Makefile: implement exclude vars for clang-format related files

* source/Makefile: exclude configuration.h from clang-format check

* Dockerfile: add diffutils in a container to make check-style target using advanced version of diff to get more advanced output to parse & navigate log more easily

* source/Makefile: implement parser for clang-format inside check-style target to make output compatible with gcc-like error compilation format for compatibility with IDEs/editors for easy navigation over files to fix style errors

* source/Makefile: probably final touches on unifying style

* source/Makefile: implement check-style-list target to only list affected file names with wrong code style for debug purposes

* source/Makefile: fix missed spaces

* deploy.sh: add helper routine to deal with clang-format error output logging from makefile

* gitignore: add clang-format log explicitly

* Refactoring for clang-format compiance

* Dockerfile: add sed

* Dockerfile: false alarm - remove sed since busybox-sed seems fine

* source/Makefile: reduce calls of clang-format & make error log more clean, clear, and tidy

* deploy.sh:check_style() - add removal of DOS EOLs for generated log

* source/Makefile:check-style: add more empty lines between blocks with errors for readability when suggestion is too long & heavy

* source/Makefile: add STOP var to check-style for exit on first failed file

* source/Makefile: check-style: make log looks more like traditional diff/patch output

* source/Core/BSP/Pinecilv2/MemMang/heap_5.c: clang-format refactoring using reasonable advises ... and then disable it in Makefile from scanning by clang-format

* Return headers include order

* clang-format config: disable warnings about non-alphabetic include order

* clang-format refactoring

* clang-format refactoring, part 2

* clang-format refactoring, part 3

* settingsGUI.cpp: refactoring, part 1

* settingsGUI.cpp: refactoring, part 2

* settingsGUI.cpp: refactoring, part 3

* settingsGUI.cpp: refactoring, part 4

* clang-format should be happy now

* workflows/push: put readme check into separate build step & update style

* clang-format: giving SortIncludes option second chance by tweaking a couple of headers a bit

* source/Makefile: check-style: add homebrew parser to check for { } in conditional blocks

* homebrew-format: add { } for if/else, while, and for & unify some comments style; left two errors intentionally to debug & improve parser

* source/Makefile: homebrew-format: fix false negative trigger for multi-line condition in if-s

* Sleep.cpp: unify style & comments

* source/Makefile: remove unused debug target
2023-07-16 15:25:30 +10:00
Ivan Zorin
4649df6914 Implement autogeneration of Documentation/README.md (#1738)
* mkdocs.yml: unify formatting style

* Docs/README.md: add auto-generated README.md file for Documentation/ directory

* Docs/README.md: fix refs

* Docs/README.md: fix locations

* Docs/README.md: trying workaround spaces in filenames for refs

* Documentation/README.md: update generated file trying to fix all formatting issues

* Documentation/README.md: reduce title size

* Documentation/README.md: add link for official online docs

* scripts/deploy.sh: implement docs_readme function

* deploy.sh: add overwrite warning in help output

* deploy.sh: try to fix shellcheck warnings

* deploy.sh:docs_readme() - show note message only if README should be updated

* deploy.sh:docs_readme() - fix shellcheck

* github/push: add Documentation/README.md check

* github/push: force usage of /bin/sh for deploy.sh script

* testing, testing, testing

* deploy.sh:docs_readme() - make error-related message more clear about what to donext

* Revert change used only to test failure on github CI
2023-07-11 09:36:05 +10:00
Ivan Zorin
311dbeac6f Fix echo in top-level Makefile for some environments (#1737)
* Makefile: fix echo for some environments by replacing escape chars with explicit formatting by spaces and new lines

* Dockerfile: extend comments for documentation purpose & switch WORKDIR to IronOS source tree root dir for the seamless workflow
2023-07-09 22:01:44 +10:00
Ivan Zorin
b524a99ff2 Root directory content refactoring (#1725)
* Root directory refactoring: - move info about Bootup Logo from a sepatate README to main README; - replace separate root scripts build.sh and start_dev.sh by root Makefile; - make Scripts directory and move there: flash_ts100_linux.sh script, ci/ directory, dockerfile, LICENSE_RELEASE, and PULL_REQUEST_TEMPLATE; - reconfigure build & deploy scripts according to changes

* Scripts => scripts

* Scripts -> scripts: re-add missing renamed files

* Directories refactoring: add top-level Makefile, add scripts/deploy.sh script, move github templates from top-level dir to .github, organize files inside Development Resources

* Update scripts/deploy.sh accroding to codestyle syntax shellcheck

* Makefile: add docs-deploy target for mkdocs gh-deploy

* Rename IronOS.yml > Env.yml, update related files

* Docs configs: remove empty characters

* docs/devel: update usage of new script
2023-07-02 11:32:40 +10:00