salfter/fluxengine
1
0
Fork 0
mirror of https://github.com/davidgiven/fluxengine.git synced 2025-10-31 11:17:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Fix a bunch of documentation strings.

Browse Source
This commit is contained in:
David Given
2021-05-18 21:10:59 +02:00
parent 9d2a5fee86
commit 9df35c1814
7 changed files with 53 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
lib/fluxsource/fluxsource.proto
View File

@@ -3,19 +3,18 @@ syntax = "proto2";
import "lib/common.proto";
message HardwareFluxSourceProto {
optional int32 drive = 1 [default = 0];
optional double revolutions = 2 [default = 1.2];
optional int32 drive = 1 [default = 0, (help) = "which drive to read from"];
optional double revolutions = 2 [default = 1.2, (help) = "number of revolutions to read"];
optional bool sync_with_index = 3 [default = false];
optional IndexMode index_mode = 4 [default = INDEXMODE_DRIVE];
optional int32 hard_sector_count = 5 [default = 0];
optional bool high_density = 6
[default = true, (help) = "set if this is a high density disk"];
optional bool sync_with_index = 3 [default = false, (help) = "start reading at index mark"];
optional IndexMode index_mode = 4 [default = INDEXMODE_DRIVE, (help) = "index pulse source"];
optional int32 hard_sector_count = 5 [default = 0, (help) = "number of hard sectors on disk"];
optional bool high_density = 6 [default = true, (help) = "set if this is a high density disk"];
}
message TestPatternFluxSourceProto {
optional double interval_us = 1 [default = 4.0];
optional double sequence_length_us = 2 [default = 200.0];
optional double interval_us = 1 [default = 4.0, (help) = "interval between pulses"];
optional double sequence_length_us = 2 [default = 200.0, (help) = "length of test sequence"];
}
message EraseFluxSourceProto {}
@@ -36,7 +35,7 @@ message CwfFluxSourceProto {
message FluxSourceProto {
oneof source {
string fluxfile = 1;
string fluxfile = 1 [default = "name of source flux file"];
HardwareFluxSourceProto drive = 2;
TestPatternFluxSourceProto test_pattern = 3;
EraseFluxSourceProto erase = 4;