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

Dokumentace #4

Open
kaklik opened this issue Dec 15, 2021 · 6 comments
Open

Dokumentace #4

kaklik opened this issue Dec 15, 2021 · 6 comments
Assignees

Comments

@kaklik
Copy link
Contributor

kaklik commented Dec 15, 2021

Modul SiPM má v této konstrukci již několik variant. Jak je vidět ve složce hw.

Momentálně implementovaný způsob zacházení s verzemi ale vede k tomu, že není jasné co je aktuální verze. Například v konstrukci GEODOSu se používá PCB AIRDOSC01A_PCB01B. Přitom by zřejmě bylo logičtější zachovat původní název a vytvořit například modul SIPM02A. Uvnitř modulů MLAB. Důsledky aktuálního stavu jsou:

  • V zařízení GEODOS lze jen těžko odkázat na konkrétní dokumentaci AIRDOSC01A_PCB01B (nelze ji vložit jako submodul)
  • Nejde snadno udržovat issues ke konstrukci AIRDOSC01A_PCB01B, protože nemá samostatný repozitář
  • Nelze tuto konstrukci forknout a použít v dalších zařízeních.

Navrhoval bych tento modul od dokumentace AIRDOSC odtrhnout do nového repozitáře v mlab-modules. Zároveň tento modul přejmenovat společně s přechodem na jeho novější verzi.
Moduly které se dnes zřejmě nepoužívají, zřejmě například SiPM01B by měly být taktéž v samostatném repozitáři v mlab modules.

Konvenci pojmenování modulů jako AIRDOSC01A_PCB01B bych v budoucnu navrhoval používat pouze pro PCB, které s jistotou nelze samostatně používat, nebo použít v jiném zařízení a jsou tudíž spolehlivě MLAB nekompatibilní.

@kaklik
Copy link
Contributor Author

kaklik commented Apr 2, 2022

Pokusil jsem se to vyřešit vytvořením samostatného repozitáře SIPM v mlab-modules. Jenže se při přesunu hnad prvního modulu SIPM01A ukázalo, že zároveň existuje i v repozitáři Modules.
Přesunutí tak není jednoduché, neboť oba moduly se stejným názvem mají rozdílnou historii změn

@kaklik
Copy link
Contributor Author

kaklik commented Apr 2, 2022

Tak jsem částečně uklidil vytvořením nových MLAB repositářů s moduly SIPM02 a SIPMPOWER01. Nedovedu ale vyřešit problém s dokumentací SIPM01.

@ChroustJan
Copy link
Contributor

SIPM01 není možné sloučit. Jsou to dva rozdílné moduly. Ten v MLAB repozitáři nemá výrobní data. Očekával bych tedy, že se ani nevyráběl. Proto bych navrhoval, pokud chceme SIPM01 z UST přesunout do MLAB modulů ho přejmenovat na SIPM03. A u UST SIPM01 zachovat jeho název. SIPM01 v UST AIRDOSC01 má ještě verzi SIPM01B.

@ChroustJan ChroustJan assigned kaklik and unassigned ChroustJan Apr 4, 2022
@kaklik
Copy link
Contributor Author

kaklik commented Apr 4, 2022

SIPM01 není možné sloučit. Jsou to dva rozdílné moduly. Ten v MLAB repozitáři nemá výrobní data. Očekával bych tedy, že se ani nevyráběl. Proto bych navrhoval, pokud chceme SIPM01 z UST přesunout do MLAB modulů ho přejmenovat na SIPM03. A u UST SIPM01 zachovat jeho název. SIPM01 v UST AIRDOSC01 má ještě verzi SIPM01B.

Tuhle úvahu nechápu. Pokud SIPM01 v repozitáři AIRDOSC nahrahuje ten modul, který je v MLAB modules o kterém navíc tvrdíš, že se nikdy nevyráběl. Tak nevidím žádný důvod ho přejmenovávat. Protože název SIPM01A i SIPM01B je kompatibilní s MLAB a taktéž návrh toho modulu je MLAB kompatibilní. Tudíž to vidím tak, že zdejší modul v AIRDOSC nahrazuje ten původní v MLAB, který se asi nějakým omylem stal balastem v repozitáři.

@ChroustJan
Copy link
Contributor

ChroustJan commented Apr 4, 2022

Navrhuji ten MLAB balast přejmenovat na SIPM03. Přijde mi škoda ten návrh zahodit. Stál nějaký čas a nevím zda se někdy nehodí. Byla to iterace.

@kaklik
Copy link
Contributor Author

kaklik commented Apr 4, 2022

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants