origen 0.0.6 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/bin/origen +42 -11
- data/config/development.rb +1 -1
- data/config/version.rb +1 -1
- data/lib/origen.rb +3 -2
- data/lib/origen/application/deployer.rb +16 -12
- data/lib/origen/commands.rb +1 -2
- data/lib/origen/commands/web.rb +5 -2
- data/lib/origen/operating_systems.rb +28 -0
- data/lib/origen/revision_control/git.rb +1 -1
- data/lib/origen/ruby_version_check.rb +3 -3
- data/lib/origen/site_config.rb +8 -0
- data/lib/tasks/private/build.rake +8 -0
- data/origen_site_config.yml +14 -4
- data/templates/shared/web/_logo.html +10 -0
- data/templates/web/archive.md.erb +11 -0
- data/templates/web/contact.md.erb +15 -0
- data/templates/web/docs/environment/definitions.md.erb +17 -0
- data/templates/web/docs/environment/installation.md.erb +22 -0
- data/templates/web/docs/environment/introduction.md.erb +5 -0
- data/templates/web/index.md.erb +12 -0
- data/templates/web/layouts/_basic.html.erb +13 -0
- data/templates/web/layouts/_doc.html.erb +34 -0
- data/templates/web/partials/_navbar.html.erb +24 -0
- data/templates/web/references.md.erb +39 -0
- data/templates/web/release_notes.md.erb +5 -0
- metadata +18 -8
- data/bin/ctags +0 -0
- data/bin/rgen +0 -2
- data/lib/origen/commands/ctags.rb +0 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4350de32d0891efe015658e118c9454077395083
|
4
|
+
data.tar.gz: d0326aca835cddce8ca2505ff1675dd71b7669e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 84fcbbd28d3fd674b559c9da1b23ee409ba5b87e0c45575802185b61c0dba099deeff5a4ed4ade116026fa8d64d8a08667ccc4914163c56426d7afe7372a62c7
|
7
|
+
data.tar.gz: ea3b529d25acddc27a7c639acad1e74afe7c114d5273e59b01da7bbe37b968db1f06e6f968d6c058ac20c56c51ff2b3900a191a25016f52f83a024a0c53525c7
|
data/bin/origen
CHANGED
@@ -7,8 +7,9 @@ require "fileutils"
|
|
7
7
|
class OrigenBootError < StandardError
|
8
8
|
end
|
9
9
|
|
10
|
-
ORIGEN_MIN_GCC_VERSION = "4.
|
10
|
+
ORIGEN_MIN_GCC_VERSION = "4.6.3"
|
11
11
|
|
12
|
+
load File.expand_path('../../lib/origen/operating_systems.rb', __FILE__)
|
12
13
|
load File.expand_path('../../lib/origen/site_config.rb', __FILE__)
|
13
14
|
|
14
15
|
# This will be referenced later in ruby_version_check, the origen used to launch
|
@@ -46,13 +47,23 @@ if origen_root
|
|
46
47
|
ENV['BUNDLE_BIN'] = File.join(origen_root, "lbin")
|
47
48
|
end
|
48
49
|
|
49
|
-
if origen_root && File.exist?(ENV['BUNDLE_GEMFILE'])
|
50
|
+
if origen_root && File.exist?(ENV['BUNDLE_GEMFILE']) && Origen.site_config.gem_manage_bundler
|
51
|
+
# Retrieve any system gem specs that might be required before we enter the clean env
|
52
|
+
if Origen.site_config.gem_manage_bundler && Origen.site_config.gem_use_from_system
|
53
|
+
system_gem_specs = Origen.site_config.gem_use_from_system.map do |gem, version|
|
54
|
+
Gem::Specification.find_by_name(gem, version)
|
55
|
+
end
|
56
|
+
else
|
57
|
+
system_gem_specs = []
|
58
|
+
end
|
59
|
+
|
50
60
|
# Overriding bundler here so that bundle install can be automated as required
|
51
61
|
require 'bundler/shared_helpers'
|
52
62
|
if Bundler::SharedHelpers.in_bundle?
|
53
63
|
require 'bundler'
|
54
64
|
if STDOUT.tty?
|
55
65
|
begin
|
66
|
+
fail OrigenBootError unless File.exist?(ENV['BUNDLE_BIN'])
|
56
67
|
Bundler.setup
|
57
68
|
fail OrigenBootError unless File.exist?(ENV['BUNDLE_BIN'])
|
58
69
|
rescue Gem::LoadError, Bundler::BundlerError, OrigenBootError => e
|
@@ -64,10 +75,12 @@ if origen_root && File.exist?(ENV['BUNDLE_GEMFILE'])
|
|
64
75
|
`chmod o-w #{origen_root}/bin` if File.exist?("#{origen_root}/bin")
|
65
76
|
`chmod o-w #{origen_root}/.bin` if File.exist?("#{origen_root}/.bin")
|
66
77
|
result = false
|
78
|
+
|
79
|
+
# Set this here since the clean environment will not have access to the ENV variable
|
67
80
|
local_gem_dir = "#{ENV['BUNDLE_PATH']}/ruby/2.1.0"
|
68
|
-
|
81
|
+
|
69
82
|
Bundler.with_clean_env do
|
70
|
-
if
|
83
|
+
if Origen.os.unix?
|
71
84
|
if Origen.site_config.gem_build_switches
|
72
85
|
Origen.site_config.gem_build_switches.each do |switches|
|
73
86
|
`bundle config build.#{switches}`
|
@@ -96,12 +109,30 @@ if origen_root && File.exist?(ENV['BUNDLE_GEMFILE'])
|
|
96
109
|
# Some gems (particularly those with C extensions that need to be built), can be hard to install reliably
|
97
110
|
# across a large user base. Initially seed the user's local gem area with the system-installed gems,
|
98
111
|
# this means that the system Ruby owner can provide an installation for these hard-to-install gems.
|
99
|
-
unless
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
112
|
+
unless system_gem_specs.empty?
|
113
|
+
%w(bin cache extensions gems specifications).each do |subdir|
|
114
|
+
d = "#{local_gem_dir}/#{subdir}"
|
115
|
+
FileUtils.mkdir_p(d) unless File.exist?(d)
|
116
|
+
end
|
117
|
+
system_gem_specs.each do |spec|
|
118
|
+
begin
|
119
|
+
(spec.executables || []).each do |bin|
|
120
|
+
FileUtils.cp("#{spec.bin_dir}/#{bin}", "#{local_gem_dir}/bin")
|
121
|
+
end
|
122
|
+
FileUtils.cp(spec.cache_file, "#{local_gem_dir}/cache")
|
123
|
+
if spec.extension_dir && File.exist?(spec.extension_dir)
|
124
|
+
spec.extension_dir =~ /.*extensions(.*)/
|
125
|
+
sub_dir = Pathname.new($1).dirname.to_s
|
126
|
+
local_ext_dir = "#{local_gem_dir}/extensions/#{sub_dir}"
|
127
|
+
FileUtils.mkdir_p(local_ext_dir) unless File.exist?(local_ext_dir)
|
128
|
+
FileUtils.cp_r(spec.extension_dir, local_ext_dir)
|
129
|
+
end
|
130
|
+
FileUtils.cp_r(spec.gem_dir, "#{local_gem_dir}/gems")
|
131
|
+
FileUtils.cp(spec.spec_file, "#{local_gem_dir}/specifications")
|
132
|
+
rescue
|
133
|
+
puts "Had problems installing #{spec.name} from your system Ruby, proceeding with fingers crossed..."
|
134
|
+
end
|
135
|
+
end
|
105
136
|
end
|
106
137
|
end
|
107
138
|
result = system(cmd)
|
@@ -109,7 +140,7 @@ if origen_root && File.exist?(ENV['BUNDLE_GEMFILE'])
|
|
109
140
|
`chmod o-w #{ENV["BUNDLE_BIN"]}`
|
110
141
|
# Make .bat versions of all executables, Bundler should really be doing this when running
|
111
142
|
# on windows
|
112
|
-
if
|
143
|
+
if Origen.os.windows?
|
113
144
|
bat_present = File.exist? "#{origen_root}/lbin/origen.bat"
|
114
145
|
Dir.glob("#{origen_root}/lbin/*").each do |bin|
|
115
146
|
unless bin =~ /.bat$/
|
data/config/development.rb
CHANGED
@@ -4,7 +4,7 @@ require "c99/doc_interface"
|
|
4
4
|
# The majority of this class is defined in the support application,
|
5
5
|
# this is to test that the importing application can override and
|
6
6
|
# extend imported classes.
|
7
|
-
|
7
|
+
require_relative "../lib/c99/nvm"
|
8
8
|
|
9
9
|
# Dummy definition to allow Origen tests to run until the Testers plugin is available
|
10
10
|
module Testers
|
data/config/version.rb
CHANGED
data/lib/origen.rb
CHANGED
@@ -1,6 +1,8 @@
|
|
1
1
|
require 'English'
|
2
2
|
require 'pathname'
|
3
3
|
require 'fileutils'
|
4
|
+
require 'origen/site_config'
|
5
|
+
require 'origen/operating_systems'
|
4
6
|
require 'origen/core_ext'
|
5
7
|
require 'origen/acronyms'
|
6
8
|
require 'origen/callbacks'
|
@@ -15,7 +17,6 @@ require 'origen/version_checker'
|
|
15
17
|
require 'origen/logger_methods'
|
16
18
|
require 'option_parser/optparse'
|
17
19
|
require 'bundler'
|
18
|
-
require 'origen/site_config'
|
19
20
|
|
20
21
|
module Origen
|
21
22
|
autoload :Features, 'origen/features'
|
@@ -530,7 +531,7 @@ module Origen
|
|
530
531
|
end
|
531
532
|
|
532
533
|
def running_on_windows?
|
533
|
-
|
534
|
+
Origen.os.windows?
|
534
535
|
end
|
535
536
|
|
536
537
|
def running_on_linux?
|
@@ -30,8 +30,8 @@ module Origen
|
|
30
30
|
q.responses[:not_valid] = "Can't be blank"
|
31
31
|
end
|
32
32
|
Origen.log.info "Fetching the website's Git respository..."
|
33
|
+
git_repo
|
33
34
|
begin
|
34
|
-
git_repo
|
35
35
|
fail unless git_repo.can_checkin?
|
36
36
|
rescue
|
37
37
|
puts "Sorry, but you don't have permission to write to #{Origen.config.web_directory}!"
|
@@ -157,17 +157,21 @@ module Origen
|
|
157
157
|
end
|
158
158
|
|
159
159
|
def deploy_file(file)
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
160
|
+
if deploy_to_git?
|
161
|
+
fail 'File based deploy has is not support for Git yet :-('
|
162
|
+
else
|
163
|
+
remote_dir = live_remote_directory
|
164
|
+
if remote_dir
|
165
|
+
file = Origen.file_handler.clean_path_to(file)
|
166
|
+
sub_dir = Origen.file_handler.sub_dir_of(file, "#{Origen.root}/templates/web") .to_s
|
167
|
+
page = file.basename.to_s.sub(/\..*/, '')
|
168
|
+
# Special case for the main index page
|
169
|
+
if page == 'index' && sub_dir == '.'
|
170
|
+
FileUtils.cp "#{Origen.root}/web/output/index.html", remote_dir
|
171
|
+
else
|
172
|
+
FileUtils.mkdir_p("#{remote_dir}/#{sub_dir}/#{page}")
|
173
|
+
FileUtils.cp "#{Origen.root}/web/output/#{sub_dir}/#{page}/index.html", "#{remote_dir}/#{sub_dir}/#{page}"
|
174
|
+
end
|
171
175
|
end
|
172
176
|
end
|
173
177
|
end
|
data/lib/origen/commands.rb
CHANGED
@@ -173,7 +173,7 @@ end
|
|
173
173
|
|
174
174
|
case @command
|
175
175
|
when 'generate', 'program', 'compile', 'merge', 'interactive', 'target', 'environment',
|
176
|
-
'
|
176
|
+
'save', 'lsf', 'web', 'time', 'dispatch', 'rc', 'lint', 'plugin', 'fetch' # , 'add'
|
177
177
|
|
178
178
|
require "origen/commands/#{@command}"
|
179
179
|
exit 0 unless @command == 'interactive'
|
@@ -236,7 +236,6 @@ The core origen commands are:
|
|
236
236
|
interactive Start an interactive Origen console (short-cut alias: "i")
|
237
237
|
compile Compile a template file or directory (short-cut alias: "c")
|
238
238
|
rc Revision control commands, see -h for details
|
239
|
-
ctags Generate ctags file (can be used for code navigation)
|
240
239
|
save Save the new or changed files from the last run or a given log file
|
241
240
|
lsf Monitor and manage LSF jobs (short-cut alias: "l")
|
242
241
|
web Web page tools, see -h for details
|
data/lib/origen/commands/web.rb
CHANGED
@@ -43,6 +43,7 @@ The following options are available:
|
|
43
43
|
opts.on('--archive ID', String, 'Archive the documents after compiling or deploying remotely') { |id| options[:archive] = id }
|
44
44
|
opts.on('-d', '--debugger', 'Enable the debugger') { options[:debugger] = true }
|
45
45
|
opts.on('-m', '--mode MODE', Origen::Mode::MODES, 'Force the Origen operating mode:', ' ' + Origen::Mode::MODES.join(', ')) { |_m| }
|
46
|
+
opts.on('--no-serve', "Don't serve the website after compiling without the remote option") { options[:no_serve] = true }
|
46
47
|
app_options.each do |app_option|
|
47
48
|
opts.on(*app_option) {}
|
48
49
|
end
|
@@ -185,8 +186,10 @@ The following options are available:
|
|
185
186
|
end
|
186
187
|
_deployer.deploy_archive(options[:archive]) if options[:archive]
|
187
188
|
else
|
188
|
-
|
189
|
-
|
189
|
+
unless options[:no_serve]
|
190
|
+
Dir.chdir "#{Origen.root}/web/output" do
|
191
|
+
_start_server
|
192
|
+
end
|
190
193
|
end
|
191
194
|
end
|
192
195
|
|
@@ -0,0 +1,28 @@
|
|
1
|
+
module Origen
|
2
|
+
# Provides methods to detect the operating system used at runtime, an instance of
|
3
|
+
# this class is automatically instantiated as Origen.os.
|
4
|
+
#
|
5
|
+
# @example
|
6
|
+
# Origen.os.windows? # => false
|
7
|
+
# Origen.os.linux? # => true
|
8
|
+
class OperatingSystems
|
9
|
+
def windows?
|
10
|
+
!!(RUBY_PLATFORM =~ /cygwin|mswin|mingw|bccwin|wince|emx/)
|
11
|
+
end
|
12
|
+
|
13
|
+
def mac?
|
14
|
+
!!(RUBY_PLATFORM =~ /darwin/)
|
15
|
+
end
|
16
|
+
|
17
|
+
def linux?
|
18
|
+
!windows? && !mac?
|
19
|
+
end
|
20
|
+
|
21
|
+
def unix?
|
22
|
+
!windows?
|
23
|
+
end
|
24
|
+
end
|
25
|
+
def self.os
|
26
|
+
@operating_systems ||= OperatingSystems.new
|
27
|
+
end
|
28
|
+
end
|
@@ -194,7 +194,7 @@ module Origen
|
|
194
194
|
def initialized?
|
195
195
|
File.exist?("#{local}/.git") &&
|
196
196
|
git('remote -v', verbose: false).any? { |r| r =~ /#{remote_without_protocol}/ } &&
|
197
|
-
!git('status', verbose: false).any? { |l| l
|
197
|
+
!git('status', verbose: false).any? { |l| l =~ /^#? ?Initial commit$/ }
|
198
198
|
end
|
199
199
|
|
200
200
|
# Delete everything in the given directory, or the whole repo
|
@@ -5,17 +5,17 @@ def ruby_acceptable_to_run?
|
|
5
5
|
end
|
6
6
|
|
7
7
|
def min_ruby_version
|
8
|
-
if
|
8
|
+
if Origen.os.windows?
|
9
9
|
'1.9.3'
|
10
10
|
else
|
11
|
-
'2.
|
11
|
+
'2.1.0'
|
12
12
|
end
|
13
13
|
end
|
14
14
|
|
15
15
|
unless ruby_acceptable_to_run?
|
16
16
|
puts <<-END
|
17
17
|
|
18
|
-
You are currently running Ruby version #{RUBY_VERSION}, however Origen
|
18
|
+
You are currently running Ruby version #{RUBY_VERSION}, however Origen supports a minimum version of #{min_ruby_version}.
|
19
19
|
|
20
20
|
END
|
21
21
|
end
|
data/lib/origen/site_config.rb
CHANGED
@@ -3,6 +3,9 @@ module Origen
|
|
3
3
|
require 'pathname'
|
4
4
|
require 'yaml'
|
5
5
|
|
6
|
+
TRUE_VALUES = ['true', 'TRUE', '1', 1]
|
7
|
+
FALSE_VALUES = ['false', 'FALSE', '0', 0]
|
8
|
+
|
6
9
|
def method_missing(method, *args, &block)
|
7
10
|
method = method.to_s
|
8
11
|
if method =~ /(.*)!$/
|
@@ -12,6 +15,11 @@ module Origen
|
|
12
15
|
env = "ORIGEN_#{method.upcase}"
|
13
16
|
if ENV.key?(env)
|
14
17
|
val = ENV[env]
|
18
|
+
if TRUE_VALUES.include?(val)
|
19
|
+
val = true
|
20
|
+
elsif FALSE_VALUES.include?(val)
|
21
|
+
val = false
|
22
|
+
end
|
15
23
|
else
|
16
24
|
config = configs.find { |c| c.key?(method) }
|
17
25
|
val = config ? config[method] : nil
|
data/origen_site_config.yml
CHANGED
@@ -1,11 +1,21 @@
|
|
1
1
|
# GEM SETUP
|
2
2
|
|
3
|
-
# Where user's local gems will be installed
|
4
|
-
gem_install_dir: ~/.origen/gems
|
5
3
|
# If your company has an internal gem server enter it here
|
6
4
|
#gem_server: http://gems.company.net:9292
|
7
|
-
#
|
8
|
-
#
|
5
|
+
# When true Origen will configure and run Bundler in a consistent way for every
|
6
|
+
# user (recommended)
|
7
|
+
gem_manage_bundler: true
|
8
|
+
# Where user's local gems will be installed if gem_manage_bundler is set to true.
|
9
|
+
gem_install_dir: ~/.origen/gems
|
10
|
+
# Some gems can be difficult to install reliably across individual user environments.
|
11
|
+
# Such gems can be installed to a communal system Ruby and then listed here, Origen
|
12
|
+
# will then use the system version of the given gem instead of trying to install
|
13
|
+
# it fresh for each user.
|
14
|
+
# Note that this option will only be applied if gem_manage_bundler is set to true.
|
15
|
+
gem_use_from_system:
|
16
|
+
- [nokogiri, 1.6.4.1]
|
17
|
+
# Additionally any build switches/options that are required to build specific gems
|
18
|
+
# in your user environment can be defined here.
|
9
19
|
#gem_build_switches:
|
10
20
|
# - nokogiri --use-system-libraries=true --with-xml2-include=/path/to/libxml2
|
11
21
|
# - other_gem --some_build_switch
|
@@ -0,0 +1,10 @@
|
|
1
|
+
<div class="pull-right logo-rgen" style="margin-top: 18px; margin-left: 10px">
|
2
|
+
<a href="http://origen-sdk.org" style="text-decoration: none; color: #e66a08; font-weight: bold; font-size: 20px;">
|
3
|
+
<span>Origen</span>
|
4
|
+
</a>
|
5
|
+
</div>
|
6
|
+
<div class="pull-right">
|
7
|
+
<a href="http://origen-sdk.org">
|
8
|
+
<img src="http://rgen.freescale.net/img/fsl_logo.png" style="height:40px">
|
9
|
+
</a>
|
10
|
+
</div>
|
@@ -0,0 +1,11 @@
|
|
1
|
+
% render "layouts/basic.html", tab: :archive do
|
2
|
+
|
3
|
+
## Archive
|
4
|
+
|
5
|
+
Documentation from previous releases is available via the links below:
|
6
|
+
|
7
|
+
% Origen.app.versions.reverse_each do |version|
|
8
|
+
* [<%= version %>](<%= Origen.app.config.web_domain %>/<%= version.gsub(".", "_") %>)
|
9
|
+
% end
|
10
|
+
|
11
|
+
% end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
% render "layouts/basic.html", tab: :contact do
|
2
|
+
|
3
|
+
## Contact Us
|
4
|
+
|
5
|
+
The following engineers can be contacted about this application:
|
6
|
+
|
7
|
+
% Origen.app.developers.each do |user|
|
8
|
+
% if user.email
|
9
|
+
* [<%= user.name %>](mailto://<%= user.email %>)
|
10
|
+
% else
|
11
|
+
* <%= user.name %>
|
12
|
+
% end
|
13
|
+
% end
|
14
|
+
|
15
|
+
% end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
% render "../../layouts/doc.html" do
|
2
|
+
|
3
|
+
%# Add any new entries anywhere in this list, it will get sorted into
|
4
|
+
%# alphabetical order during compilation:
|
5
|
+
%
|
6
|
+
% terms = {
|
7
|
+
% "Origen" => "A general purpose semiconductor engineering framework that uses the Ruby programming language, read more at http://origen.freescale.net",
|
8
|
+
% "Application" => "The generic name given to a project that uses Origen",
|
9
|
+
% }
|
10
|
+
|
11
|
+
| Term or Acronym | Definition
|
12
|
+
|:----------------|:----------
|
13
|
+
% terms.sort.each do |term|
|
14
|
+
| <%= term[0] %> | <%= term[1] %>
|
15
|
+
% end
|
16
|
+
|
17
|
+
% end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
% render "../../layouts/doc.html" do
|
2
|
+
|
3
|
+
Follow the steps below to setup a new environment.
|
4
|
+
|
5
|
+
#### 1. Install Origen
|
6
|
+
|
7
|
+
Follow these instructions to install Origen: [How to Install Origen](http://origen.freescale.net/origen/latest/guides/starting/installing)
|
8
|
+
|
9
|
+
#### 2. Create the application workspace
|
10
|
+
|
11
|
+
This workspace must be situated outside of the Origen workspace that you have just created.
|
12
|
+
|
13
|
+
Execute the following commands:
|
14
|
+
|
15
|
+
~~~
|
16
|
+
mkdir <%= Origen.app.name %>
|
17
|
+
cd <%= Origen.app.name %>
|
18
|
+
dssc setvault <%= Origen.config.vault %> .
|
19
|
+
dssc pop -rec -uni -get -force -ver <%= Origen.app.version %> .
|
20
|
+
~~~
|
21
|
+
|
22
|
+
% end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
% render "layouts/basic.html" do
|
2
|
+
|
3
|
+
%# HTML tags can be embedded in mark down files if you want to do specific custom
|
4
|
+
%# formatting like this, but in most cases that is not required.
|
5
|
+
<h1><%= Origen.app.namespace %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
|
6
|
+
|
7
|
+
### Introduction
|
8
|
+
|
9
|
+
Use this page to give a brief overview of what your application does, put the detail
|
10
|
+
in the docs section.
|
11
|
+
|
12
|
+
% end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: <%= options[:title] || Origen.app.namespace %>
|
3
|
+
---
|
4
|
+
<%= render "templates/web/partials/navbar.html", tab: options[:tab] %>
|
5
|
+
|
6
|
+
<div class="row">
|
7
|
+
%# The markdown attribute is important if you are going to include content written
|
8
|
+
%# in markdown, without this is will be included verbatim
|
9
|
+
<div class="span12" markdown="1">
|
10
|
+
<%= yield %>
|
11
|
+
|
12
|
+
</div>
|
13
|
+
</div>
|
@@ -0,0 +1,34 @@
|
|
1
|
+
---
|
2
|
+
title: <%= options[:title] || "#{Origen.app.namespace} - Docs" %>
|
3
|
+
---
|
4
|
+
<%= render "templates/web/partials/navbar.html", tab: :docs %>
|
5
|
+
% s = {}
|
6
|
+
|
7
|
+
%# This creates the index on the left of your doc pages
|
8
|
+
%#
|
9
|
+
%# Naming of the keys is very important and must be of the form:
|
10
|
+
%# <section>_<page> with no other underscores
|
11
|
+
%# Origen will then look for the corresponding page in:
|
12
|
+
%# templates/web/docs/<section>/<page>.md.erb
|
13
|
+
%#
|
14
|
+
%# See here for more info: http://origen.freescale.net/doc_helpers/latest/examples/searchable/intro/
|
15
|
+
|
16
|
+
% s["Environment"] = {
|
17
|
+
% environment_introduction: "Introduction",
|
18
|
+
% environment_installation: "Installation",
|
19
|
+
% environment_definitions: "Definitions and Acronyms",
|
20
|
+
% }
|
21
|
+
%
|
22
|
+
%# Define additional sections as required, e.g.
|
23
|
+
%# s["Registers"] = {
|
24
|
+
%# registers_map: "Register Map",
|
25
|
+
%# }
|
26
|
+
|
27
|
+
|
28
|
+
% render "doc_helpers/searchable.html", options.merge(:index => s) do
|
29
|
+
|
30
|
+
<%= yield %>
|
31
|
+
|
32
|
+
<%= yammer_comments %>
|
33
|
+
|
34
|
+
% end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
<nav class="navbar navbar-inverse navbar-fixed-top">
|
2
|
+
<div class="container">
|
3
|
+
<div class="navbar-header">
|
4
|
+
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
|
5
|
+
<span class="sr-only">Toggle navigation</span>
|
6
|
+
<span class="icon-bar"></span>
|
7
|
+
<span class="icon-bar"></span>
|
8
|
+
<span class="icon-bar"></span>
|
9
|
+
</button>
|
10
|
+
<a class="navbar-brand" href="<%= path "/" %>">Home</a>
|
11
|
+
</div>
|
12
|
+
<div id="navbar" class="collapse navbar-collapse">
|
13
|
+
<ul class="nav navbar-nav">
|
14
|
+
<li class="<%= options[:tab] == :docs ? 'active' : '' %>"><a href="<%= path("/docs/environment/introduction") %>">Docs</a></li>
|
15
|
+
<li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
|
16
|
+
<li class="<%= options[:tab] == :references ? 'active' : '' %>"><a href="<%= path "/references" %>">References</a></li>
|
17
|
+
<li class="<%= options[:tab] == :archive ? 'active' : '' %>"><a href="<%= path "/archive" %>">Archive</a></li>
|
18
|
+
<li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
|
19
|
+
<li class="<%= options[:tab] == :contact ? 'active' : '' %>"><a href="<%= path "/contact" %>">Contact</a></li>
|
20
|
+
</ul>
|
21
|
+
<%= import "origen/web/logo.html" %>
|
22
|
+
</div><!--/.nav-collapse -->
|
23
|
+
</div>
|
24
|
+
</nav>
|
@@ -0,0 +1,39 @@
|
|
1
|
+
% render "layouts/basic.html", tab: :references do
|
2
|
+
|
3
|
+
## References
|
4
|
+
|
5
|
+
%# An example of how to write a references page:
|
6
|
+
%#### Documents
|
7
|
+
%#
|
8
|
+
%#* Block Guides
|
9
|
+
%# * [FTFL Block Guide](http://compass.freescale.net/go/ftflspecs)
|
10
|
+
%# * [FTFE Block Guide](http://compass.freescale.net/go/ftfespecs)
|
11
|
+
%# * [FTFA Block Guide](http://compass.freescale.net/go/ftflspecs)
|
12
|
+
%#* Hardmacro Creation Guides
|
13
|
+
%# * [TFSL Creation Guide](http://compass.freescale.net/go/tfsspec)
|
14
|
+
%# * [TFSE Creation Guide](http://compass.freescale.net/go/tfsspec)
|
15
|
+
%#* Training
|
16
|
+
%# * [FTFL Overview](http://compass.freescale.net/livelink/livelink/207024304/FTFL_Overview.ppt?func=doc.Fetch&nodeid=207024304)
|
17
|
+
%#* Quality
|
18
|
+
%# * [Quality Level Cheatsheet](http://compass.freescale.net/livelink/livelink/227376170/SOC_3.6_NVM_Quality_Level_1409_C90TFS.xlsx?func=doc.Fetch&nodeid=227376170)
|
19
|
+
%#
|
20
|
+
%#### Origen
|
21
|
+
%#
|
22
|
+
%#* [Origen Documentation](http://origen.freescale.net)
|
23
|
+
%#* [Origen Freeshare Commmunity](http://freeshare.freescale.net:2222/public/origen-cmty-svc/Pages/PublicHome.aspx)
|
24
|
+
%#
|
25
|
+
%#### Design Sync Vaults
|
26
|
+
%#
|
27
|
+
%#* C90TFS NVM Test Module
|
28
|
+
%# * <%= Origen.config.vault %>
|
29
|
+
%#* FTFL Design
|
30
|
+
%# * sync://sync-15040:15040/Projects/nvm_c90tfsw/ftfl
|
31
|
+
%# * sync://sync-15040:15040/Projects/nvm_c90tfsw/ftfl_firmware
|
32
|
+
%#* FTFE Design
|
33
|
+
%# * sync://sync-15040:15040/Projects/nvm_c90ftfe/ftfe
|
34
|
+
%# * sync://sync-15040:15040/Projects/nvm_c90ftfe/ftfe_firmware
|
35
|
+
%#* FTFA Design
|
36
|
+
%# * sync://sync-15040:15040/Projects/nvm_c90tfsw/ftfa
|
37
|
+
%# * sync://sync-15040:15040/Projects/nvm_c90tfsw/ftfa_firmware
|
38
|
+
|
39
|
+
% end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: origen
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.8
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Stephen McGinty
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2015-
|
11
|
+
date: 2015-07-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activesupport
|
@@ -344,14 +344,14 @@ dependencies:
|
|
344
344
|
requirements:
|
345
345
|
- - '='
|
346
346
|
- !ruby/object:Gem::Version
|
347
|
-
version: 0.1.
|
347
|
+
version: 0.1.1
|
348
348
|
type: :development
|
349
349
|
prerelease: false
|
350
350
|
version_requirements: !ruby/object:Gem::Requirement
|
351
351
|
requirements:
|
352
352
|
- - '='
|
353
353
|
- !ruby/object:Gem::Version
|
354
|
-
version: 0.1.
|
354
|
+
version: 0.1.1
|
355
355
|
- !ruby/object:Gem::Dependency
|
356
356
|
name: origen_doc_helpers
|
357
357
|
requirement: !ruby/object:Gem::Requirement
|
@@ -385,13 +385,10 @@ email:
|
|
385
385
|
- stephen.f.mcginty@gmail.com
|
386
386
|
executables:
|
387
387
|
- origen
|
388
|
-
- rgen
|
389
388
|
extensions: []
|
390
389
|
extra_rdoc_files: []
|
391
390
|
files:
|
392
|
-
- bin/ctags
|
393
391
|
- bin/origen
|
394
|
-
- bin/rgen
|
395
392
|
- config/application.rb
|
396
393
|
- config/commands.rb
|
397
394
|
- config/development.rb
|
@@ -447,7 +444,6 @@ files:
|
|
447
444
|
- lib/origen/commands.rb
|
448
445
|
- lib/origen/commands/add.rb
|
449
446
|
- lib/origen/commands/compile.rb
|
450
|
-
- lib/origen/commands/ctags.rb
|
451
447
|
- lib/origen/commands/dispatch.rb
|
452
448
|
- lib/origen/commands/environment.rb
|
453
449
|
- lib/origen/commands/fetch.rb
|
@@ -509,6 +505,7 @@ files:
|
|
509
505
|
- lib/origen/model_initializer.rb
|
510
506
|
- lib/origen/nvm.rb
|
511
507
|
- lib/origen/nvm/block_array.rb
|
508
|
+
- lib/origen/operating_systems.rb
|
512
509
|
- lib/origen/parameters.rb
|
513
510
|
- lib/origen/parameters/live.rb
|
514
511
|
- lib/origen/parameters/missing.rb
|
@@ -676,6 +673,7 @@ files:
|
|
676
673
|
- lib/origen/version_checker.rb
|
677
674
|
- lib/origen/version_string.rb
|
678
675
|
- lib/tasks/gem.rake
|
676
|
+
- lib/tasks/private/build.rake
|
679
677
|
- origen_site_config.yml
|
680
678
|
- source_setup
|
681
679
|
- spec/format/origen_formatter.rb
|
@@ -703,6 +701,7 @@ files:
|
|
703
701
|
- templates/nanoc/lib/helpers.rb
|
704
702
|
- templates/nanoc/lib/search_filter.rb
|
705
703
|
- templates/nanoc_dynamic/content/search.js.erb
|
704
|
+
- templates/shared/web/_logo.html
|
706
705
|
- templates/test/_inline_sub.txt.erb
|
707
706
|
- templates/test/environment.txt.erb
|
708
707
|
- templates/test/inline.txt.erb
|
@@ -720,6 +719,17 @@ files:
|
|
720
719
|
- templates/test/set3/content.html.erb
|
721
720
|
- templates/time/filter.rb.erb
|
722
721
|
- templates/time/rules.rb.erb
|
722
|
+
- templates/web/archive.md.erb
|
723
|
+
- templates/web/contact.md.erb
|
724
|
+
- templates/web/docs/environment/definitions.md.erb
|
725
|
+
- templates/web/docs/environment/installation.md.erb
|
726
|
+
- templates/web/docs/environment/introduction.md.erb
|
727
|
+
- templates/web/index.md.erb
|
728
|
+
- templates/web/layouts/_basic.html.erb
|
729
|
+
- templates/web/layouts/_doc.html.erb
|
730
|
+
- templates/web/partials/_navbar.html.erb
|
731
|
+
- templates/web/references.md.erb
|
732
|
+
- templates/web/release_notes.md.erb
|
723
733
|
homepage: http://origen-sdk.org
|
724
734
|
licenses:
|
725
735
|
- LGPL-3
|
data/bin/ctags
DELETED
Binary file
|
data/bin/rgen
DELETED
@@ -1,9 +0,0 @@
|
|
1
|
-
puts 'Generating ctags file...'
|
2
|
-
# system("ctags -R --exclude='.ref/**,output/**' #{ORIGEN_WORK} #{ORIGEN_TOP}/lib")
|
3
|
-
Origen.load_application
|
4
|
-
if Origen.top == Origen.root
|
5
|
-
system("ctags -R #{Origen.top}/lib -f #{Origen.root}/tags")
|
6
|
-
else
|
7
|
-
system("ctags -R #{Origen.top}/lib #{Origen.root}/lib -f #{Origen.root}/tags")
|
8
|
-
end
|
9
|
-
puts 'Completed successfully'
|