From 0a2ff52029fd9af4e3d2b3c41bd836acb546c8fa Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Thu, 30 Mar 2023 13:39:52 -0700 Subject: [PATCH 1/3] Clarify ipld/car relatioship with ipld/go-car Adjust migration tool config so that don't update users to boxo/ipld/car by default. --- cmd/boxo-migrate/internal/config.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/cmd/boxo-migrate/internal/config.go b/cmd/boxo-migrate/internal/config.go index a377ec687..767d86002 100644 --- a/cmd/boxo-migrate/internal/config.go +++ b/cmd/boxo-migrate/internal/config.go @@ -39,7 +39,10 @@ var DefaultConfig = Config{ "github.com/ipfs/go-ipfs-routing": "github.com/ipfs/boxo/routing", "github.com/ipfs/go-ipfs-exchange-interface": "github.com/ipfs/boxo/exchange", "github.com/ipfs/go-merkledag": "github.com/ipfs/boxo/ipld/merkledag", - "github.com/ipld/go-car": "github.com/ipfs/boxo/ipld/car", + // By default, users can/should keep using ipld/go-car. + // Updating ipld/go-car was useful for other repos that are also maintained by Boxo maintainers like Kubo + // More info is in https://github.com/ipfs/boxo/issues/218 + // "github.com/ipld/go-car": "github.com/ipfs/boxo/ipld/car", // Pre Boxo rename "github.com/ipfs/go-libipfs/gateway": "github.com/ipfs/boxo/gateway", From 3c9aaec378680ab58644640798cb012f603b24a7 Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Thu, 30 Mar 2023 13:49:04 -0700 Subject: [PATCH 2/3] Update ipld/car readme --- ipld/car/README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/ipld/car/README.md b/ipld/car/README.md index b91dcf148..a7c2e8df0 100644 --- a/ipld/car/README.md +++ b/ipld/car/README.md @@ -1,9 +1,18 @@ -go-car (go!) -================== +# ❗ About CAR libraries written in go +As of 202303, this is a copy of [`ipld/go-car`](github.com/ipld/go-car). +`ipld/go-car` is a full-featured car library that is actively maintained. +Boxo has smaller car needs and will be will be refactored and thinned out soon. +Boxo can't depend on `ipld/go-car` because it would cause `ipld/go-car` to have dependency on Boxo, +and `ipld/go-car` maintainers want to be able to develop indepdently. -[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai) -[![Go Reference](https://pkg.go.dev/badge/github.com/boxo/ipld/car.svg)](https://pkg.go.dev/github.com/boxo/ipld/car) +***A user can always use `ipld/go-car` in conjuection with `boxo/ipld/car`.*** +Please use `ipld/go-car` as needed! +More details and discussion are [here](https://github.com/ipfs/boxo/issues/218). + +--- + +# About this module > Work with car (Content addressed ARchive) files! This is a Golang implementation of the [CAR specifications](https://ipld.io/specs/transport/car/), both [CARv1](https://ipld.io/specs/transport/car/carv1/) and [CARv2](https://ipld.io/specs/transport/car/carv2/). @@ -16,11 +25,6 @@ As a format, there are two major module versions: Most users should use v2, especially for new software, since the v2 API transparently supports both CAR formats. -# **Unstable** - -This package will be refactored and thinned out soon. You can find an -implementation that supports indexes and go-ipld-prime there at [`ipld/go-car`](github.com/ipld/go-car). - ## Usage / Installation This repository provides a `car` binary that can be used for creating, extracting, and working with car files. From 1fcb4ffc65bc45d89be0475b101c14521fe3b896 Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Thu, 6 Apr 2023 00:25:09 -0700 Subject: [PATCH 3/3] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit soon → in the future since there aren't specific plans here (if there were, there should be an issue describing it) --- ipld/car/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ipld/car/README.md b/ipld/car/README.md index a7c2e8df0..62dd779ba 100644 --- a/ipld/car/README.md +++ b/ipld/car/README.md @@ -1,7 +1,7 @@ # ❗ About CAR libraries written in go As of 202303, this is a copy of [`ipld/go-car`](github.com/ipld/go-car). `ipld/go-car` is a full-featured car library that is actively maintained. -Boxo has smaller car needs and will be will be refactored and thinned out soon. +Boxo has smaller car needs and will be will be refactored and thinned out in the future. Boxo can't depend on `ipld/go-car` because it would cause `ipld/go-car` to have dependency on Boxo, and `ipld/go-car` maintainers want to be able to develop indepdently.