employer
/
tame
1
0
Fork 0
Code Packages Releases Activity

tameld: Move documentation to tamer::ld

master
Mike Gerwitz 2019-12-10 00:33:53 -05:00
parent f2b24e6505
commit 541fbffc2e
2 changed files with 32 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
tamer/src/bin/tameld.rs
View File

@ -19,19 +19,8 @@
//! utility. Its job is to take each of the compiled object files and
//! produce a final executable.
//!
//! # Backwards-Compatibility (XSLT System)
//! This linker is part of the TAMER (TAME in Rust) project, which aims to
//! incrementally rewrite TAME in Rust. Consequently, it must be able to
//! serve as a drop-in replacement for the existing (XSLT) linker, which
//! takes as input `xmlo` files and produces as output an `xmle` file. This
//! is not efficient, and future versions will begin to migrate away from
//! this strategy.
//!
//! The output `xmle` file is then fed to a `standalone` command which
//! extracts the JavaScript fragment and places it into its own file. Even
//! when that is replaced (when this just outputs a final JS file directly),
//! the `xmle` file is still needed for other purposes, such as `summary`
//! and `dote` generation.
//! For more information about the linker,
//! see the [`tamer::ld`] module.
extern crate tamer;

30
tamer/src/ld.rs
View File

@ -15,4 +15,34 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//! The [linker][] is responsible for combining individually compiled
//! [object files][] into a final executable.
//!
//! It's user-facing binary is [`tameld`][tameld].
//!
//! **TODO:** More information.
//!
//! [linker]: https://en.wikipedia.org/wiki/Linker_(computing)
//! [object files]: https://en.wikipedia.org/wiki/Object_file
//! [tameld]: ../../tameld
//!
//! Backwards-Compatibility (XSLT System)
//! -------------------------------------
//! This linker is part of the TAMER (TAME in Rust) project,
//! which aims to incrementally rewrite TAME in Rust.
//! Consequently, it must be able to serve as a drop-in replacement for the
//! existing (XSLT) linker,
//! which takes as input `xmlo` files and produces as output an `xmle`
//! file.
//! *This is not efficient*,
//! and future versions will begin to migrate away from this strategy.
//!
//! The output `xmle` file can then be fed to a `standalone` command which
//! extracts the JavaScript fragment and places it into its own file.
//! Even when that is replaced
//! (when this just outputs a final JS file directly),
//! the `xmle` file is still needed for other purposes,
//! such as `summary` and `dote` generation.
//! Those too will eventually be linker targets.
pub mod poc;