clevis icon indicating copy to clipboard operation
clevis copied to clipboard

pin template with documentation, sample "file" pin

Open cbiedl opened this issue 5 years ago • 5 comments

At least for me, writings pins was hard since I had to figure out the concept behind them, and when studying the existing ones, finding out what's generic pin logic and what it specific for that pin wasn't that easy either.

That should not be repeated for anyone else, so I created src/pins/template/ and filled it my several files and a lot of explanations embedded.

Also a new pin "file" as a demonstration of a minimal pin that uses a file to store the key. I'd consider this suitable for educational puposes only, but you think it's worth to include it in the official distribution, go ahead. Actually, this was im preparation of #185 which will get a fix soon.

cbiedl avatar May 24 '20 19:05 cbiedl

Certainly. Not being a native English speaker, such glitches do happen. Do you want an updated pull request? Might be less work if you just do it on your own.

cbiedl avatar Jan 28 '23 11:01 cbiedl

Okay, found some minor issues so I've updated my branch (also, rebased it on top of HEAD). This resulted in some warnings/errors from CI I fail to understand. Feel free to take it as-is.

cbiedl avatar Jan 28 '23 16:01 cbiedl

Okay, found some minor issues so I've updated my branch (also, rebased it on top of HEAD). This resulted in some warnings/errors from CI I fail to understand. Feel free to take it as-is.

Thanks for the PR. The differential shellcheck issue looks like a false positive, so no need to worry for that.

sarroutbi avatar Feb 22 '23 17:02 sarroutbi

Is there any way one can assist to getting this merged?

ghost avatar Nov 30 '23 06:11 ghost

Changes LGTM. @sergio-correia: can you please provide feedback when possible?

sarroutbi avatar Nov 30 '23 08:11 sarroutbi