Wiki code for ON SCM-Related Tools

Hide Line numbers
1: = [[OpenSolaris>>Main.WebHome]]
2: 
3: [[>>Main.WebHome]][[Discussions>>Main.discussions]] [[Communities>>Main.#portal]] [[Projects>>Main.#portal]] [[Download>>Main.downloads]] [[Source Browser>>http://src.opensolaris.org/]] Last updated: 5/19/06
4: 
5: = ON Consolidation: SCM-related Tools
6: 
7: **There are two tables of data**
8: 
9: * [[Tools owned by the ON Gatekeepers>>#Tools_Owned_by_the_ON_Gatekeepers]]
10: * [[Tools owned by the ON Community>>#Tools_Owned_by_the_ON_Community]]
11: 
12: **
13:  COLUMN DESCRIPTIONS**
14: 
15: * **Name/Description/Owner**
16: ** Name of the tool
17: * Short description of the tool
18: * Owner, if not noted by the table title
19: * **++** in this column with text denotes standards enforced by the tool
20: * ****** in this column denotes functionality the owner(s) or user(s) would like to have
21: * **User(s)**
22: ** Known user(s) of the tool
23: * **Use Frequency**
24: ** How often the tool is used/run
25: * **Source Location**
26: ** Where the source can be found
27: * **Implementation Language**
28: ** Language in which tool is written
29: * **UI Employed**
30: ** User interface(s) employed by the tool, i.e., the UI the tool presents to the user
31: * **SCM Hooks Used by Tool**
32: ** SCM hooks used to invoke the tool
33: * **Run Type**
34: ** How the tool is run: on demand or automatically
35: * **Dependencies**
36: ** Dependencies on SCCS and/or TeamWare
37: * Usually denotes 
38: *** the use of SCCS and/or TeamWare in the tool’s normal operations
39: * intimate knowledge about the internals of SCCS and/or TeamWare
40: * **Access Needs**
41: ** Does the tool need to access history information, i.e., non-current data in the tree
42: * **Input Data**
43: ** Does the tool require input data from sources other than what is (currently) found in the SCM repository
44: * **Produced Data**
45: ** Does the tool produce data that is in turn consumed by other systems such as e-mail
46: * **Output Archived**
47: ** Does the output of the tool require archiving
48: 
49: **
50:  TABLE NOTES**
51: 
52: * Tables are numbered with prefixes to make entries unique
53: ** OG = Tool owned by the ON gatekeepers
54: * OC = Tool owned by the ON community
55: * C = Tool owned by another community
56: * Tools are listed alphabetically within a table
57: 
58: **CONTENT NOTES**
59: 
60: * For ON, there are tools whose only connection to SCCS or TeamWare are that they explicitly avoid the SCCS directory or make some other incidental use of the SCM.  These types of tools are believed to number between one and 24.  They are not listed on these tables.
61: 
62: = **Tools Owned by the ON Gatekeepers**
63: 
64: |
65: **Tools Owned by the ON Gatekeepers**
66: |
67: **ID**
68: |
69: **Name/Description**
70: |
71: **User(s)**
72: |
73: **Use Frequency**
74: |
75: **Source Location**
76: |
77: **Implementation Language**
78: |
79: **UI Employed**
80: |
81: **SCM Hooks Used by Tool**
82: |
83: **Run Type**
84: |
85: **Dependencies**
86: |
87: **Access Needs**
88: |
89: **Input Data**
90: |
91: **Produced Data**
92: |
93: **Output Archived**
94: |
95: OG1
96: |
97: **add-gateling**:  adds a person to the gatelings and notify lists when they do a bringover from the gate or the clone
98: ****** It would be great to have a real email address for the person bringing over, rather than a username which might be unique to someone’s laptop.  We have to prune the lists wenever someone with a non-global userid brings over.  There’s a bunch of hackery in there right now that almost completely reduces that to zero, but that won’t scale outside Sun.
99: |
100: Everyone who brings over from ON (~700); 
101:  ON gatekeeping staff is primary user
102: |
103: every few minutes
104: |
105: /ws/onnv-gate/public/gate/bin/add-gateling
106: also in the IHV gate
107: |
108: ksh
109: |
110: CLI
111: |
112: bringover
113: |
114: On demand
115: |
116: TeamWare
117: |
118: None
119: |
120: None
121: |
122: Creates a mailing list
123: |
124: Yes
125: |
126: OG2
127: |
128: **backout**:  aids in creating an anti-delta in order to back out a bug
129: |
130: ON gatekeeping staff
131: |
132: 1x-2x per build
133: |
134: /ws/onnv-gate/public/gk/bin/backout
135: |
136: ksh
137: |
138: CLI
139: |
140: Uses putback mail logs to find files associated with a bugid;
141:  parses SCCS history to discover what deltas are associated with a bugid.
142: |
143: On demand
144: |
145: SCCS
146: |
147: History
148: |
149: Putback Logs
150: |
151: Anti-deltas.  Applies them to files in a workspace which can then be checked in and putback.
152: |
153: No
154: |
155: OG3
156: |
157: **buglist**: extracts the list of bugs that went into a build
158: |
159: ON gatekeeping staff
160: |
161: 1x-2x per build
162: |
163: /w/onnv-gate/public/gk/bin/buglist
164: |
165: ksh
166: |
167: CLI
168: |
169: None
170: |
171: Automatic/
172:  sometimes on demand
173: |
174: Putback logs
175: |
176: History
177: |
178: Yes
179: |
180: List of bugs.  List used by the RTC and to mark fix delivered.
181: |
182: Yes
183: |
184: OG4
185: |
186: **clone_update**: does the nightly clone "snapshot"
187: ****** It would be nice for the clone to be a ZFS snapshot of the gate which would require (other than actually having the gate on ZFS) a productized version of zbringover.
188: |
189: ON gatekeeping staff
190: |
191: nightly
192: |
193: /ws/onnv-gate/public/gate/bin/clone_update
194: |
195: ksh
196: |
197: CLI
198: |
199: None
200: |
201: On demand
202: |
203: TeamWare
204: |
205: None
206: |
207: Works with TeamWare’s lock file, breaking all locks before doing the bringover (and notifying people that it’s done so)
208: |
209: None (except bringover itself)
210: |
211: No
212: |
213: OG5
214: |
215: **daily_snapshot**: creates a daily snapshot of the gate sources
216: ****** ZFS integration would be fantastic.  Danek is currently running a parallel clone that does take a snapshot every night, but those snapshots need to be available as separate workspaces.
217: |
218: ON gatekeeping staff
219: |
220: nightly
221: |
222: /ws/onnv-gate/public/gate/bin/daily_snapshot
223: |
224: ksh
225: |
226: CLI
227: |
228: None
229: |
230: Automatic
231: |
232: Mostly doesn’t depend on TeamWare: uses cpio to transfer the files, though it isn’t clear why this is the case.
233: |
234: None
235: |
236: None
237: |
238: Email (informative)
239: |
240: No (other than the snapshots themselves)
241: |
242: OG6
243: |
244: **daily_update**: maintains a shadow gate to allow for diffs generation
245: ****** This tool shouldn’t exist.  If the SCM we choose requires something like this, we’ve picked the wrong SCM.
246: |
247: ON gatekeeping staff
248: |
249: nightly, after the clone, to make sure that the "daily" workspace isn’t out of date
250: |
251: /ws/onnv-gate/public/gate/bin/daily_update
252: |
253: ksh
254: |
255: CLI
256: |
257: None
258: |
259: Automatic
260: |
261: TeamWare, for bringover
262: |
263: None
264: |
265: None, other than the locking mechanism
266: |
267: Email
268:  (almost always uninteresting)
269: |
270: |
271: OG7
272: |
273: **lock-check**: warns if the gate is locked for too long
274: |
275: ON gatekeeping staff
276: |
277: every 5 minutes
278: |
279: /ws/onnv-gate/public/gk/bin/lock-check
280: |
281: ksh
282: |
283: CLI
284: |
285: TeamWare’s lock file
286: |
287: Automatic (via cron)
288: |
289: TeamWare
290: |
291: None
292: |
293: None
294: |
295: Email
296: |
297: No
298: |
299: OG8
300: |
301: **lock-gate/unlock-gate**: lock the gate from all putbacks/bringovers in case of emergency
302: |
303: ON gatekeeping staff
304: |
305: 1x per build
306: |
307: /ws/onnv-gate/public/gk/bin/lock-gate
308: |
309: ksh
310: |
311: CLI
312: |
313: None/All:
314:  Modifies the SCM’s access control file
315: |
316: On demand
317: |
318: TeamWare
319: |
320: None
321: |
322: Manipulates repository-wide metadata
323: |
324: None
325: |
326: No
327: |
328: OG9
329: |
330: **pbcheck**: not to be confused with "wx pbcheck": does a subset of "wx pbchk" checking on the gate after each putback, including cstyle, jstyle, hdrchk, as well as some permissions checking, sending an email if something needs to be fixed
331: **++** Enforces development standards.
332: ****** It should perform its check before the putback happens.  It should also do the full "wx pbchk", plus a few other things, but wx doesn’t have the ability to check an arbitrary workspace based on a putback that’s already happened (it’s possible, but hacky, and hasn’t been high enough priority).
333: |
334: ON gatekeeping staff/
335:  ON community
336: |
337: on every putback
338: |
339: /ws/onnv-gate/public/gate/bin/pbcheck
340: |
341: ksh
342: |
343: CLI
344: |
345: putback-to
346: |
347: Automatic
348: |
349: SCCS/TeamWare
350: |
351: History (immediately preceding delta)
352: |
353: None
354: |
355: Email (when finds problems)
356: |
357: No
358: |
359: OG10
360: |
361: **pbconfirm**: sends a message to the engineer preforming a putback that the putback happened, what build it went into, and what the next steps are
362: |
363: ON gatekeeping staff/
364:  ON community
365: |
366: on every putback
367: |
368: /ws/onnv-gate/public/gate/bin/pbconfirm
369: also in the IHV gate
370: |
371: ksh
372: |
373: CLI
374: |
375: putback-to
376: |
377: Automatic
378: |
379: TeamWare
380: |
381: None
382: |
383: Build Schedule
384: |
385: Email
386: |
387: No
388: |
389: OG11
390: |
391: **pre-mkdelivery**: takes the snapshot, does all the biweekly-build bookkeeping, kicks off the builds
392: |
393: ON gatekeeping staff
394: |
395: bi-weekly
396: |
397: /ws/onnv-gate/public/gk/bin/pre-mkdelivery
398: |
399: ksh
400: |
401: CLI
402: |
403: None
404: |
405: Automatic (can be on demand)
406: |
407: SCCS: minor: updates the onnv web page which is under SCCS control.
408:  TeamWare: uses bringover to create the snapshots and pre-populate the build workspaces, as well as doing the equivalent of lock-gate (#4) on the snapshot.  Intimately familiar with the structure of the ON workspace under TeamWare to shware the snapshot properly.
409: |
410: None
411: |
412: Not directly (some of the tools it runs look in the logs)
413: |
414: |
415: |
416: OG12
417: |
418: **putback_diffs**: backend workhorse - creates diffs/webrev, pings doc writes, checks to make sure RTIs are approved
419: ****** RTI should be checked before putback.  There should be no need for the daily workspace - indeed, diffs generation should be a trivial operation with any modern SCM.
420: |
421: ON gatekeeping staff/
422:  few other who have expressed interest in these diffs
423: |
424: on every putback
425: |
426: /ws/onnv-gate/public/gate/bin/putback_diffs
427: |
428: ksh
429: |
430: CLI
431: |
432: putback-to
433: |
434: Automatic
435: |
436: SCCS: to produce the delta tree diffs
437:  TeamWare
438: |
439: History
440: |
441: RTI database, daily workspace
442: |
443: Email/
444:  creates web pages/
445:  maintains another workspace
446: |
447: Yes
448: |
449: OG13
450: |
451: **update_SUNWonbld**: maintains the copies of SUNWonbld on the gate machines
452: |
453: ON gatekeeping staff
454: |
455: run nightly (doesn’t necessarily do something every night)
456: |
457: /ws/onnv-gate/public/gate/bin/update_SUNWonbld
458: |
459: ksh
460: |
461: CLI
462: |
463: None
464: |
465: Automatic
466: |
467: TeamWare: to maintain the tools build workspace
468: |
469: None
470: |
471: None
472: |
473: Email (for human to verify that everything worked)
474: |
475: No
476: |
477: OG14
478: |
479: **update_flagdays**: maintains the ON flagday web page
480: ****** NLP to merge updates to flag-day/heads-up messages.
481: |
482: ON gatekeeping staff
483: |
484: after many putbacks
485: |
486: /ws/onnv-gate/public/gate/bin/update_flagdays
487: |
488: ksh
489: |
490: CLI
491: |
492: putback-to
493: |
494: Automatic
495: |
496: TeamWare: parses TeamWare putback messages
497: |
498: None
499: |
500: None
501: |
502: Maintains a web page
503: |
504: Yes
505: 
506: = **Tools Owned by the ON Community**
507: 
508: |
509: **Tools Owned by the ON Community**
510: |
511: **ID**
512: |
513: **Name/Description**
514: |
515: **User(s)**
516: |
517: **Use Frequency**
518: |
519: **Source Location**
520: |
521: **Implementation Language**
522: |
523: **UI Employed**
524: |
525: **SCM Hooks Used by Tool**
526: |
527: **Run Type**
528: |
529: **Dependencies**
530: |
531: **Access Needs**
532: |
533: **Input Data**
534: |
535: **Produced Data**
536: |
537: **Output Archived**
538: |
539: OC1
540: |
541: **keywords**: checks a soruce file to ensure that SCCS keywords haven’t improperly been checked in in an expanded format
542: **++** Enforces development standards
543: ****** Following bugs are filed against keywords:
544:  4701837 keywords should also work on files not in SCCS
545:  4747405 RFE: keywords should have an option to generate canonical ident strings
546:  4793568 keywords -p should complain about #pragma in non-C files
547:  At least on keywords wad is in flight, which will fix 4793568.  Unclear whether others have plans for keywords that aren’t logged in bugster.
548: **Owner**: ON community.  Usually maintained by people on the gatekeeping alias.
549: |
550: ON community
551: |
552: on every putback/plus uncountable times on individual workspaces
553: |
554: /ws/onnv-gate/usr/src/tools/scripts/keywords.sh
555: |
556: sh
557: |
558: CLI
559: |
560: None
561: |
562: On demand/
563:  Automatic after every putback
564: |
565: SCCS
566: |
567: Checked-out copy of a file
568: |
569: None
570: |
571: Output is consumed only by humans
572: |
573: No
574: |
575: OC2
576: |
577: **nightly**: builds ON and some other consolidations
578: **++** Enforces development standards
579: ****** There are 40+ bugs in bugster against nightly, and probably everyone has his/her own set of pet peeves about it since it is one of the most highly visible faces of ON.
580: **Owner**: ON community.  Usually maintained by people on the gatekeeper alias.
581: |
582: ON community
583: |
584: nightly/and many other times
585: |
586: /ws/onnv-gate/usr/src/tools/scripts/nightly.sh
587: |
588: sh
589: |
590: CLI
591: |
592: None
593: |
594: On demand/gatekeepers run automatically
595: |
596: SCCS/TeamWare
597: |
598: Fully historied tree.  None of its semantic operations require this (though some operations are made easier by the presences of SCCS directories)
599: |
600: Nees a file generated by the user to operate fully correctly
601: |
602: Email
603: |
604: No
605: |
606: OC3
607: |
608: **sccscp/sccsmv/sccsrm/sccshist**: tools to manipulate both the SCCS s-file and g-file in a workspace
609: **Owner**: ON community.  Usually maintained by people on the gatekeeper alias.
610: |
611: ON community
612: |
613: occasionally
614: |
615: /ws/onnv-gate/usr/src/tools/scripts/sccscp.sh
616: |
617: sh
618: |
619: CLI
620: |
621: None
622: |
623: On demand
624: |
625: SCCS
626: |
627: SCCS files must be present
628: |
629: None
630: |
631: None
632: |
633: No
634: |
635: OC4
636: |
637: **squelch_client**: client that is triggered on every putback to maintain the read-only ON Subversion repository on serum.sfbay
638: **Owner**: Steve Lau
639: |
640: Steve Lau
641: |
642: on every putback
643: |
644: /ws/onnv-gate/public/gate/bin/squelch_client
645: |
646: perl
647: |
648: CLI
649: |
650: putback-to
651: |
652: Automatic
653: |
654: TeamWare: mail output format
655: |
656: None
657: |
658: None
659: |
660: Yes - passed to a server
661: |
662: Yes
663: |
664: OC5
665: |
666: **webrev**: creates a set of web pages containing the differences between two workspaces
667: **++** Used to aid the eyeball enforcement of development standards
668: ****** As with nightly, lots of people have their own ideas about what other cools things it could do.
669: **Owner**: ON community.  Usually maintained by people on the gatekeeper alias.
670: |
671: ON community
672: |
673: very frequently
674: |
675: /ws/onnv-gate/usr/src/tools/scripts/webrev.sh
676: |
677: ksh
678: |
679: CLI
680: |
681: None
682: |
683: On demand/some gatekeepers run automatically
684: |
685: SCCS/TeamWare
686: |
687: File history
688: |
689: Access to the parent repository
690: |
691: Creates a web page
692: |
693: No (but it often is)
694: |
695: OC6
696: |
697: **wx**: wrapper for SCCS/TeamWare
698: **++** Enforces development standards: cstyle, &c, copyrights, CDDL comment block
699: ****** cf nightly, webrev
700: ****** Suggestion to replace this with a tool that performs the same functions but that operates faster (performance is very bad, at least for remote users)
701: **Owner**: ON community.  Usually maintained by people on the gatekeeper alias.  Will Fiveash currently has the dirtiest fingers.
702: |
703: ON community
704: |
705: all the time
706: |
707: /ws/onnv-gate/usr/src/tools/scripts/wx.sh
708: |
709: ksh
710: |
711: CLI
712: |
713: None
714: |
715: Mostly On demand
716: |
717: SCCS/TeamWare
718: |
719: History access
720: |
721: Access to the parent repository, as well as a few files it maintains itself (as directed by the user)
722: |
723: None
724: |
725: No
726: |
727: OC7
728: |
729: **zbringover**: quickly do an initial bringover of a pre-built ON workspace using ZFS snapshot/clone to create a new workspace
730: **Owner**: ZFS Team
731: |
732: ZFS Team
733: |
734: Few times per week
735: |
736: /ws/zfs-gate/usr/src/cmd/zbringover/zbringover.sh
737: |
738: ksh
739: |
740: CLI
741: |
742: Manually groks TeamWare data and "fixes up" workspace to look like a real child of the original parent
743: |
744: On demand
745: |
746: TeamWare
747: |
748: None
749: |
750: None
751: |
752: None
753: |
754: No
755: 
756: [[image:ontools_files/s77757566796637||width="1"]]
OpenSolaris

Top Menu

Wiki code for ON SCM-Related Tools

Search

Collectives

Community Group

Project

User Group

Subsites

Community Group tools Pages
