File: naming.html

package info (click to toggle)
pcb-rnd 3.1.7b-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,108 kB
  • sloc: ansic: 213,400; yacc: 6,241; sh: 4,698; awk: 3,016; makefile: 2,254; lex: 1,166; python: 519; xml: 261; lisp: 154; tcl: 67; perl: 34; javascript: 6; ruby: 5
file content (16 lines) | stat: -rw-r--r-- 1,214 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<html>
<body>
<h1> pcb-rnd hacking - plugin naming conventions </h1>
	<ul>
		<li> export_: export plugins start with export_; these render to a non-native format that can not be then loaded
		<li> import_: import plugins start with import_; these perform partial data load from alien formats (typically: netlist/schematics)
		<li> io_: full board save/load prefixed with io_; even if your plugin can now only load or save, if it's possible to do a load-save-load round-trip without data loss, it's an io_
		<li> hid_: interactive, often GUI, frontends are prefixed with hid_
		<li> fp_: footprint access plugins start with fp_
		<li> lib_ plugins are libraries used by other plugins; they are disabled by default and are enabled through the plugin dependency system
		<li> act_ plugins are stateless wrappers to expose existing C functions (moslty core functionality) over the action API (for scripts and users)
		<li> ar_ plugins are related to external autorouting: they are reponsible for calling the external process and coordinate the routing but sometimes also implement export/import pair for the format
		<li> anything else is considered a feature plugin and has no specific prefix.
	</ul>
</body>
</html>